Skip to content

Improve a few contribution notes in the README #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 10, 2022
Merged

Improve a few contribution notes in the README #12

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8441c1b
Improve a few contribution notes in the README
JamesMGreene Aug 5, 2022
9f6ed02
Tweak the title and description in README
JamesMGreene Aug 8, 2022
90b7c04
Merge branch 'main' into better-docs
JamesMGreene Aug 10, 2022
491169d
Revise release procedure
JamesMGreene Aug 10, 2022
a220556
Merge branch 'main' into better-docs
JamesMGreene Aug 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

An action to enable Pages and extract various metadata about a site. It can also be used to configure various static site generators we support as [starter workflows][starter-workflows].

See [`set-pages-path.js`](./src/set-pages-path.js) for more details on how we configure static site generators to work "out of the box" with GitHub Pages.
See [`set-pages-path.js`](src/set-pages-path.js) for more details on how we configure static site generators to work "out of the box" with GitHub Pages.

# Usage

Expand All @@ -12,9 +12,9 @@ See [action.yml](action.yml) and the [Pages starter workflows][starter-workflows

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])
1. Locate the semantic version of the [upcoming release][release-list] (a draft is maintained by the [`draft-release` workflow][draft-release])

2. Push a matching tag, for instance for `v0.1.0`:
2. Push a matching tag (e.g.`v0.1.0`) **if** different than the `main` branch (if not, publishing the draft release will create it):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really? That's cool, do we even need this whole step then?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, not really. I didn't do it at all for the latest release.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can consider removing it in the future, but there is probably a bit more clarification to add regarding making sure the branch name is correct in the Release UI and such. 🤔

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I published without yesterday. Let's remove the step. Publishing a release does it for us.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revised. 👍🏻


```bash
git tag v0.1.0
Expand All @@ -23,13 +23,15 @@ In order to release a new version of this Action:

3. Publish the draft release (the major tag such as `v0` will be created/updated by the [`release` workflow][release])

⚠️ Environment approval is required.
⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs].

# License

The scripts and documentation in this project are released under the [MIT License](LICENSE).

<!-- references -->
[starter-workflows]: https://github.com/actions/starter-workflows/tree/main/pages
[release-list]: /releases
[draft-release]: .github/workflows/draft-release.yml
[release]: .github/workflows/release.yml
[release]: .github/workflows/release.yml
[release-workflow-runs]: /actions/workflows/release.yml