Fix the docs to reference latest version and make it a little easier to manage #24
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
…se, and update the docs to match
JackMead
commented
Mar 17, 2022
Comment on lines
+12
to
+13
| with: | ||
| fetch-depth: 0 |
There was a problem hiding this comment.
This is necessary for the extract-version-from-tag-action@v1.0.0 action
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.
The key intent here was to make sure the latest version was actually the one displayed in the docs, as I had an issue with this recently caused by confusion when we thought 1.0.0 was the latest version but discovered the arguments etc. all shown on the Readme were out of sync with that version. I then wanted to make it a little more sustainable rather than bumping this doc for every minor/patch release, so have suggested extending the action to automatically move the major version tag (e.g. V2) whenever a minor/patch is released, as per the suggestion in the docs so that future users can just ask for
v2and consistently receive the most up to date version despite no change to the current release process.Happy to limit this to just the doc change (but tweaked to point to a specific minor version) if you'd rather not add the other section