feat: add retag-release workflow to add a vX.Y.Z tag for our GitHub Action #545
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erunion
reviewed
Jul 28, 2022
kanadgupta
reviewed
Jul 28, 2022
RyanGWU82
deleted the
ryanp/rm-4840-create-a-post-rdme-publish-script-that
branch
kanadgupta
added a commit
that referenced
this pull request
Jul 28, 2022
* fix: support files with .markdown extension * test: random cleanup fixing typo, removing unused version param, stricter error checks * refactor: DRY some docs logic * feat: add retag-release workflow to add a vX.Y.Z tag for our GitHub Action (#545) * feat: add retag-release workflow to add a vX.Y.Z tag for our GitHub Action * Update .github/workflows/retag-release.yaml Co-authored-by: Kanad Gupta <[email protected]> * refactor: move code out of YAML and into bin/ script * fix: lint fixes Co-authored-by: Kanad Gupta <[email protected]> Co-authored-by: Ryan Park <[email protected]>
kanadgupta
added a commit
that referenced
this pull request
Jul 28, 2022
* chore: create custompages cmd category * test: fixtures * feat: initial pass at commands as part of this, we had to slightly refactor the pushDoc function to augment the data to support the HTML file handling required by the custompages API * test: initial pass at tests * docs: update README usage * test: remove unused version params, stricter error checks * fix(docs/single): support files with `.markdown` extension (#549) * fix: support files with .markdown extension * test: random cleanup fixing typo, removing unused version param, stricter error checks * chore: capitalize Markdown * chore: lowercase all file extension checks * refactor: DRY some docs logic (#550) * fix: support files with .markdown extension * test: random cleanup fixing typo, removing unused version param, stricter error checks * refactor: DRY some docs logic * feat: add retag-release workflow to add a vX.Y.Z tag for our GitHub Action (#545) * feat: add retag-release workflow to add a vX.Y.Z tag for our GitHub Action * Update .github/workflows/retag-release.yaml Co-authored-by: Kanad Gupta <[email protected]> * refactor: move code out of YAML and into bin/ script * fix: lint fixes Co-authored-by: Kanad Gupta <[email protected]> Co-authored-by: Ryan Park <[email protected]> Co-authored-by: Ryan Park <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧰 Changes
The rdme GitHub Action required people to write workflows with the line
uses: readmeio/[email protected]but GitHub's convention is for action versions to be taggedv1.2.3. Because of this some users have writtenuses: readme/[email protected]and of course they expect that to work.This workflow looks for releases created with a tag like
1.2.3and adds a second tag likev1.2.3. It uses actions/github-script which is the simplest way to run a short script in a GitHub workflow. There were some existing third-party actions for adding a tag to a repo, but I didn't really want to rely on a third-party script for something so simple. (Admittedly this was going to be a one-liner but with input validation and HTTP error checking it got a bit longer.)🧬 QA & Testing
Ran this on a little test project and it worked as expected:
Exits early when the tag doesn't follow semantic versioning style, so that we don't create tags like
vv1.2.3orvdeprecated.