Skip to content
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

Update PR comment for next version to include link to the release build #264

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ricardozv28
Copy link
Contributor

No description provided.

@ricardozv28 ricardozv28 requested a review from a team as a code owner May 16, 2024 20:43
@@ -191,7 +191,7 @@ jobs:

const nextVersionText = isMergeToMain ?
`[Tag - ${nextVersion}](https://github.com/${orgAndRepo}/releases/tag/${nextVersion})` :
`Next Version - ${nextVersion}`;
`[Next Version - ${nextVersion}](https://github.com/${orgAndRepo}/releases/${nextVersion})`;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've done some research. In the past the im-open/git-version-lite action made a tag and a release at the same time. Now they're broken into two different actions.

im-open/git-version-lite now creates a version, the second, im-open/create-release, creates the release object.

Since this reusable workflow doesn't create a release, then it's not a good place to have a link to it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could create summary output in im-open/create-release action for the link, since we know a release is created there.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why the ternary condition is the way it is. Why should it create a link to a release when isMergeToMain is true, but only output the version number without a link when it's false?

Is it a safe assumption that isMergeToMain == true is an equivalent condition to "a version tag was pushed"?

On the other hand, is it a safe assumption that if inputs.next-version has a value, then a tag must have been pushed for it?

In my opinion, the latter assumption is more likely to be true. In that case, the whole conditional expression would need to be different, and possibly even the default value for the input should be different.

Maybe like:

const nextVersionText = nextVersion === 'N/A' ?
  `Next Version - ${nextVersion}` :
  `[Tag - ${nextVersion}](https://github.com/${orgAndRepo}/releases/tag/${nextVersion})`;

Or if we change the default of the next-version input to a null or empty string:

const nextVersionText = nextVersion ?
  'Next Version - N/A' :
  `[Tag - ${nextVersion}](https://github.com/${orgAndRepo}/releases/tag/${nextVersion})`;

@@ -191,7 +191,7 @@ jobs:

const nextVersionText = isMergeToMain ?
`[Tag - ${nextVersion}](https://github.com/${orgAndRepo}/releases/tag/${nextVersion})` :
`Next Version - ${nextVersion}`;
`[Next Version - ${nextVersion}](https://github.com/${orgAndRepo}/releases/${nextVersion})`;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could create summary output in im-open/create-release action for the link, since we know a release is created there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants