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

Create GitHub release during release workflow #402

Merged
merged 3 commits into from
Feb 4, 2022
Merged

Create GitHub release during release workflow #402

merged 3 commits into from
Feb 4, 2022

Conversation

beatngu13
Copy link
Contributor

As discussed here, the current release workflow doesn't create an actual GitHub release (newest tag/release is 1.0.10, whereas the current GitHub release points to 1.0.1). This might be confusing to some users, resulting in the use of old plugin versions.

This PR uses softprops/action-gh-release to create a GitHub release during the release workflow. Note that the "official" actions/create-relase is unmaintained, and softprops/action-gh-release is one of four recommended alternatives.

Since the build workflow already uses a secret GITHUB_TOKEN, I assume it is available so that the action can use it to create a release via the GitHub API.

@abhinayagarwal
Copy link
Collaborator

Hi @beatngu13 ,

Thank you for the PR. This is indeed a nice addition as just tag and don't make the releases. I can also see that because of this the release notes created via release-drafter are showing incorrect results :)

Can you confirm if the draft release notes created via release-drafter will be automatically shown as release notes?

@beatngu13
Copy link
Contributor Author

Hey @abhinayagarwal,

Thx for getting back to me!

If I have understood correctly what release drafter does: whenever there is a merge into the main branch, a release is drafted / an existing draft is updated with the corresponding changelog? So, there should already be a bunch of release drafts (1.0.2 – 1.0.10)?

I'm not sure, but I don't think release drafter is compatible with this PR. Given that the current GitHub release is 1.0.1 instead of 1.0.10, are you still using this feature?

softprops/action-gh-release also has an option generate_release_notes, using this under the hood.

@abhinayagarwal
Copy link
Collaborator

Hi @beatngu13 ,

release-drafter just drafts release notes. It doesn't publishes them. I was hoping that we could do it via this PR.

If we can't find a way to make this work, we could remove release-drafter and use github's automatic release note generation.

P.S. I have manually added all the release notes up to v1.0.10.

@abhinayagarwal
Copy link
Collaborator

I read about automatically generated release note provided by Github. I am OK with using it. Can you update the PR to add the .github/release.yml and remove .github/release-drafter.yml?

@beatngu13
Copy link
Contributor Author

Updated the PR accordingly. Just as with release drafter, I used a single category and inherited the "What's Changed" title.

Would you mind having another look?

@abhinayagarwal
Copy link
Collaborator

Changes LGTM.

"Draft release" step from build.yml also needs to be removed as a part of this PR.

@beatngu13
Copy link
Contributor Author

Good catch, overlooked that! 👍

I squashed this change into the previous commit and also did a rebase against the current master.

@abhinayagarwal
Copy link
Collaborator

abhinayagarwal commented Jan 27, 2022

Hi @beatngu13 ,

I have approved the PR. Can you merge the latest from master branch to make the check pass?

@abhinayagarwal abhinayagarwal merged commit 4e0c639 into gluonhq:master Feb 4, 2022
@beatngu13
Copy link
Contributor Author

Thx for merging!

Feel free to ping me if that new release procedure causes any trouble.

@beatngu13 beatngu13 deleted the feature/create-gh-release branch February 4, 2022 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants