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

[Fix #348] Automate the process of GitHub release creation #363

Merged
merged 1 commit into from
Mar 3, 2025

Conversation

koic
Copy link
Member

@koic koic commented Feb 27, 2025

Follow-up to https://github.com/rubocop/rubocop/blob/master/.github/workflows/github_release.yml.

This action will be triggered when a new tag is pushed and will auto-fill the release notes using the relevant file. The rubocop-ast repository has essentially the same structure as the rubocop repository, so it should work as is.

Resolves #348.

@koic koic mentioned this pull request Feb 27, 2025
with:
tag: ${{ github.ref_name }}
name: RuboCop AST ${{ github.ref_name }}
bodyFile: relnotes/${{ github.ref_name }}.md
Copy link
Contributor

Choose a reason for hiding this comment

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

This won't work, there's no directory like this here. You would need to import the code that generates this from rubocop as well

Copy link
Member Author

@koic koic Feb 27, 2025

Choose a reason for hiding this comment

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

Ah, I had assumed that relnotes was brought over when it was extracted from RuboCop. I'll reconsider.

Copy link
Contributor

Choose a reason for hiding this comment

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

The simplest workaround is to dump the entire changelog there, but it won't be as nice.

Copy link
Member Author

@koic koic Mar 3, 2025

Choose a reason for hiding this comment

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

Yeah, I created relnotes directory and included past release files to make this workflow functional. Going forward, this workflow can work based on relnotes.

Copy link
Contributor

Choose a reason for hiding this comment

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

Great! It's be nice if we use the same approach across all official RuboCop projects.

Follow-up to https://github.com/rubocop/rubocop/blob/master/.github/workflows/github_release.yml.

This action will be triggered when a new tag is pushed and will
auto-fill the release notes using the relevant file.

The `rubocop-ast` repository has essentially the same structure as the `rubocop` repository,
so it should work as is.

Resolves rubocop#348.
@koic koic force-pushed the add_github_release_workflow branch from 38425e5 to 6ab3149 Compare March 3, 2025 08:14
@marcandre
Copy link
Contributor

Sounds great!

@marcandre marcandre merged commit 34abb4b into rubocop:master Mar 3, 2025
22 checks passed
@koic koic deleted the add_github_release_workflow branch March 3, 2025 21:36
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.

GitHub releases are missing
4 participants