From b97a591d3ac304544f62234a73c9039448481c8f Mon Sep 17 00:00:00 2001 From: Smitha Borkar <12040799+smithaborkar@users.noreply.github.com> Date: Fri, 10 Jun 2022 13:29:44 -0700 Subject: [PATCH] Update README.md --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8691737..6897902 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ -# setup-pages \ No newline at end of file +# setup-pages + +An action to enable Pages and extract metadata. + + +# Release instructions + +In order to release a new version of this Action: + +1. Locate the semantic version of the upcoming release (a draft is maintained by the [`draft-release` workflow][draft-release]) + +2. Push a matching tag, for instance for `v0.1.0`: + + ```bash + git tag v0.1.0 + git push origin v0.1.0 + ``` + +3. Publish the draft release (the major tag such as `v0` will be created/updated by the [`release` workflow][release]) + + ⚠️ Environment approval is required.