Canary version not being added to some PRs in GitHub Action

[zephraph]

Describe the bug

I've noticed that on the PRs I create that even though the canary versions are published the PR body isn't updated to have the version number.

To Reproduce

See any of my PRs for a repo.

Expected behavior

I created a repo, a canary version was deployed, but the canary PR edit wasn't made to the bottom of the repo.

Additional context

I assume that this is actually a permissions issue.

[hipstersmoothie]

@zephraph Have you seen this issue pop up lately?

[zephraph]

I have not. Will close.

[hipstersmoothie]

This could very well have happened like this:

1. push code
2. take a long time writing pr message
3. canary version publishes before you submit PR and tries to post comment to PR that hasn't yet opened
4. no canary version posted to PR

[hipstersmoothie]

@zephraph This might be an opportunity for autobot to add the canary version.

[glambert]

I see this also on 8.0.0, turning on the logs shows:

✔  success   Published canary version: <details><summary>Canary Versions</summary>- `[email protected]`
- `[email protected]`</details>

But the PR comment is not updated. I'm using the default auto init setup with npm and released plugins.

[hipstersmoothie]

Was the PR open at the time that the canary was published?

If you do the following the canary version will not post:

1. push code to new branch
2. ci runs build
3. sometimes after build you open PR
4. version never posted back

[glambert]

Build finishes after I have created the PR.

If it did finish before the PR was created, when I push new commits it still doesn’t update. Does it need to work the first time so that extra commits also update the PR description?

Thanks again for the support

[hipstersmoothie]

Does it need to work the first time so that extra commits also update the PR description?

It should not matter for subsequent builds. Any chance I can check out the repo?

Maybe your PR isn't being detected on your build platform. I'll add some logs here

https://github.com/intuit/auto/blob/master/packages/core/src/auto.ts#L692

[hipstersmoothie]

Looking at it more most everything should already be in the logs. Can you turn on veryVerbose and post a log?

We should be able to see:

1. the PR number detected https://github.com/intuit/auto/blob/master/packages/core/src/auto.ts#L653
2. PR body will also log all of what it does https://github.com/intuit/auto/blob/master/packages/core/src/auto.ts#L555

[glambert]

So PR is indeed not found for Canary release (although it gets the PR number in the first log line):

info      Getting commits for PR #4
302
ℹ  info      {
303
  currentBranch: 'package-2-update',
304
  isBaseBrach: false,
305
  isPR: false,
306
  shouldGraduate: true,
307
  isPrereleaseBranch: false,
308
  publishPrerelease: false
309
}
310
ℹ  info      Canary info found: { pr: undefined, build: undefined }
311
ℹ  info      Getting commits from HEAD^ to HEAD

FYI I’m using lerna in independent mode. The repo is internal but its a POC, so I’ll probably move it to a public one so I can show you, it’ll be easier to debug this way 🙂 Monday tho 😉

[glambert]

@hipstersmoothie Here's the test repo: https://github.com/glambert/auto-lerna-independent-poc

[hipstersmoothie]

I’ll look at this tomorrow. Thanks for the test repo! It will help a lot

…

On Sun, Dec 15, 2019 at 6:32 PM Guillaume Lambert ***@***.***> wrote: Here's the test repo: https://github.com/glambert/auto-lerna-independent-poc — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#481?email_source=notifications&email_token=AAJDEBCGLTAHIMJAI3JWYC3QY3SEHA5CNFSM4H7BEXSKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEG5KOMQ#issuecomment-565880626>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAJDEBEP47ROT67TB5KOJUTQY3SEHANCNFSM4H7BEXSA> .

[hipstersmoothie]

Ah this may be tied to some caveats I've found with GitHub actions.

This library isn't detecting the branch/PR correctly semantic-release/env-ci#96

The Getting commits for PR #4 comes from us matching the commit SHA to a PR, not the env info unfortunately.

I'm gonna play around with it a little to see if I can get env-ci to behave like I want it to

[hipstersmoothie]

It seems like the push event might not be what we want?

https://mobile.twitter.com/ethomson/status/1176421835157704704

[hipstersmoothie]

I have an incoming PR that will find the PR that the head commit is associated with for canary versions. This should help with finding the PR to comment on

[glambert]

Ahhh right, so you’d have both push and pull_request as triggers?

I’ll give a try with the canary version of the PR and let you know if it works 👍 in the end I might not use canary releases with lerna independant mode because it would create canary for all packages even unchanged ones. But at least I’ll know it works 😉

[hipstersmoothie]

Ahhh right, so you’d have both push and pull_request as triggers?

I haven't used GitHub actions all that much so IDK what the best workflow is quite yet (hopefully you can help us find it 😃). To me having multiple actions set up is kinda too much overhead. If my canary works this should alleviate the issue for the most part.

in the end I might not use canary releases with lerna independant mode because it would create canary for all packages even unchanged ones

Since multiple users have now requested that I don't force publish canaries I am open to it. But in my experience I have found that you want to force publish them for edge cases.

For instance if you change your babel config and want to test the changes on a canary version. Without force publishing lerna will not publish all anything if you just change a global config file, since no packages have actually changed.

What are your reasons for not wanting everything to update in a canary? I am not an independant user so there might be something I am missing.

[glambert]

What are your reasons for not wanting everything to update in a canary? I am not an independant user so there might be something I am missing.

We have a repository of like 20+ libs (and growing) so doing canary releases for all of these on each PR will get very noisy. What I was thinking is instead if perhaps use the next branch strategy. The good thing about using canary tho is you can test out individual commits. Is there a way to trigger canary "manually" for specific packages in independent mode perhaps? For example: run lerna changed and create canary releases for only those packages who changed. Thinking out loud here 😉

[hipstersmoothie]

not currently.

https://github.com/intuit/auto/blob/master/plugins/npm/src/index.ts#L562

I am open to adding a flag/config like --no-force-publish-canary. I do want to keep the default as it is.

[glambert]

I am open to adding a flag/config like --no-force-publish-canary. I do want to keep the default as it is

Agreed, for most cases this is what you would want.

[adierkens]

🚀 Issue was released in v9.1.0 🚀