-
Notifications
You must be signed in to change notification settings - Fork 376
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.
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
chore: correct step output key in readme #1057
Conversation
Warning: This pull request is touching the following templated files:
|
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed (or fixed any issues), please reply here with What to do if you already signed the CLAIndividual signers
Corporate signers
ℹ️ Googlers: Go here for more info. |
@googlebot I signed it! |
@@ -173,19 +173,19 @@ jobs: | |||
- uses: actions/checkout@v2 | |||
# these if statements ensure that a publication only occurs when | |||
# a new release is created: | |||
if: ${{ steps.release.outputs.release_created }} | |||
if: ${{ steps.release.outputs.releases_created }} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this is correct: https://github.com/google-github-actions/release-please-action/blob/main/index.js#L56
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we were both mistaken - it looks like releases_created
is actually set as output when there is any release: https://github.com/google-github-actions/release-please-action/blob/973b63d3d58b9a5a9fed0dd512501ad5a9ab319b/index.js#L49
Whereas release_created
wasn't removed as I initially thought, but is only set if you are releasing a package at the root of the repo(?) Regardless, IMO it would be more correct to use the output that is always set in the example code to cover more use cases.
@willarmiros are you using the manifest releaser, and this is why the What about a compromise and updating the documents for the manifest functionality to include an example of the GitHub action? |
@bcoe ah yes I am using the manifest releaser, I guess the behavior is pretty different from the single-package option. I can try to add a sample action workflow to this PR in https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md. Given manifest releases would typically be for monorepos, would it be ok to include lerna in the example for running release-please and publishing to NPM? |
@willarmiros for sure, I'd be interested in seeing how you recommend doing this for my own benefit. |
@willarmiros please feel free to dust this off if you'd like to add docs about lerna (I think this would be valuable for folks). |
Just a quick doc update - seems like the output keyname for a release being created has changed and it wasn't reflected in docs. See this output from
release-please
for evidence: https://github.com/willarmiros/test-package-lock-repo/runs/3617929254?check_suite_focus=true#step:3:4