feat: switch to tagless workflow success check #2
Conversation
|
@JamesHenry Please review One thing I would add - Mark current commit as |
README.md
Outdated
| - [Background](#background) | ||
| - [License](#license) | ||
|
|
||
| > This documentation is for version 2.x.x. If you are using version 1.x.x you also need to include accomplanying [nx-tag-successful-ci-run](https://github.com/nrwl/nx-tag-successful-ci-run) as the last step of your job, since version 1.x.x depends on the existance of git tags that mark successful runs. |
There was a problem hiding this comment.
There are a couple of typos in here (accomplanying, existance) so it needs to be changed anyway, so may I suggest instead of this paragraph we instead simply link to the README.md at the latest v1 tag?
README.md
Outdated
| # Use ${{ secrets.GITHUB_TOKEN }} as a value | ||
| # | ||
| # Required: true | ||
| GITHUB_TOKEN: '' |
There was a problem hiding this comment.
We should use ${{ github.token }} rather than forcing the user to set up a secret in their repo and then reference that in the env.
One of the great things about github actions is the fact you get a token provisioned automatically for you
There was a problem hiding this comment.
See examples on the official org of actions: https://github.com/actions
There was a problem hiding this comment.
User does not need to set up new secret in their repo, the GITHUB_TOKEN exists by default. GITHUB_XYZ and github.xyz are the same. For some reason, it wasn't working when I tried to reference the env value in the action.yml without specifying it in the workflow. But works fine with GitHub context. Thanks!
https://github.com/octokit/action.js/blob/master/README.md
README.md
Outdated
|
|
||
| - run: | | ||
| echo "BASE: ${{ steps.setSHAs.outputs.base }}" | ||
| echo "HEAD: ${{ steps.setSHAs.outputs.head }}" | ||
|
|
||
| # =========================================================================== | ||
| # OPTION 3) Specify all parameters |
There was a problem hiding this comment.
This is not really what was intended by OPTIONs here.
There are two fundamentally different ways of using the SHAs - via environment variables, or via github job outputs.
This is not a third OPTION when it comes to fundamental usage of the SHAS, so please remove.
The configuration options section below was intended to exhaustively cover all the options available
Co-authored-by: James Henry <[email protected]>
Co-authored-by: James Henry <[email protected]>
README.md
Outdated
| - [Background](#background) | ||
| - [License](#license) | ||
|
|
||
| > This documentation is for version 2.x.x. If can find documentation for version 1.x.x [here](https://github.com/nrwl/nx-set-shas/blob/c8f5a54f6ee7f2127f3df063f36a0242faee4cb7/README.md). |
There was a problem hiding this comment.
😬 typo again "if can find"
No description provided.