docs: make it clearer how the action is used#31
Merged
EndBug merged 3 commits intoEndBug:masterfrom Dec 5, 2020
Merged
Conversation
adamkudrna
commented
Nov 11, 2020
| static-checking: localIsNew | ||
| ``` | ||
|
|
||
| Now, when someone changes the version in `package.json` to `1.2.3` and pushes a commit with the message `<WHATEVER> 1.2.3` (eg. `Release 1.2.3` or `Bump version to v1.2.3`), output values are set (see Outputs below). Otherwise, no output is provided. |
EndBug
requested changes
Nov 11, 2020
Owner
EndBug
left a comment
EndBug
left a comment
There was a problem hiding this comment.
Hi, thanks for the PR! I've left a couple of comments, could you take a look at them?
| You have to set up a step like this in your workflow (this assumes you've already [checked out](https://github.com/actions/checkout) your repo and [set up Node](https://github.com/actions/setup-node)): | ||
| ### GitHub Workflow | ||
|
|
||
| You have to set up a step like this in your GitHub workflow file (eg. `.github/workflows/release-management.yml`), assuming you've already [checked out](https://github.com/actions/checkout) your repo: |
Owner
There was a problem hiding this comment.
I get that you want to use as an example of where to find a workflow file, but I think that it seems like you're referring to a file in my repo. Could you rephrase this?
| static-checking: localIsNew | ||
| ``` | ||
|
|
||
| Now, when someone changes the version in `package.json` to `1.2.3` and pushes a commit with the message `<WHATEVER> 1.2.3` (eg. `Release 1.2.3` or `Bump version to v1.2.3`), output values are set (see Outputs below). Otherwise, no output is provided. |
|
This PR is being marked as "stale" because it has been open 20 days with no activity. Remove the "stale" label or comment, otherwise this will be closed in 5 days. |
Contributor
Author
|
@EndBug Thank you for finishing the work! Unfortunately I didn't get back to it until now… |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Hello! I've just spent a couple of hours figuring out why this action doesn't work in my workflow despite it had worked before. Then I realized I didn't include new version number in my commit message this time. So I'm trying to improve the docs a bit to clearly say how the action should be used.
Furthermore, I believe that enum-type options (
assume-same-versionandstatic-checking) should have defaults other than''. It's confusing to read that accepted values areoldornewwhile the default is''. I didn't edit this as it probably requires code changes as well.