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 releases automatically on tagging #7041

Closed
kou opened this issue Jan 28, 2025 · 0 comments · Fixed by #7042
Closed

Create GitHub releases automatically on tagging #7041

kou opened this issue Jan 28, 2025 · 0 comments · Fixed by #7042
Labels
enhancement Any new improvement worthy of a entry in the changelog

Comments

@kou
Copy link
Member

kou commented Jan 28, 2025

Is your feature request related to a problem or challenge? Please describe what you are trying to do.

GitHub has a feature that manages releases: GitHub releases: https://docs.github.com/en/repositories/releasing-projects-on-github

All GitHub repositories have https://github.com/${ORGANIZATION}/${REPOSITORY}/releases. https://github.com/apache/arrow-rs/releases is for apache/arrow-rs.

Many projects use the feature to show changes in a release, provide artifacts (e.g. source archive) and so on. If we use it like other projects, users may be easy to find changes in each release.

Describe the solution you'd like

We can create GitHub releases from existing our contents. For example, we can use existing CHANGELOG.md for changes in a release.

It's not a big task but it's better that we automate it.

Describe alternatives you've considered

We can do it as a manual task in a release process. For example: https://github.com/apache/arrow-rs/pull/7031/files#diff-7b90af0d72004d8b923b4ed55f67a5f3e40e6a08ec9637f382d6506dd309848dR204

### Create a GitHub release

Run a command such as the following to create a GitHub release from the tag:

```shell
git checkout 4.1.0
gh release create 4.1.0 --title 4.1.0 --notes-file CHANGELOG.md
```

Additional context

Other Arrow projects such as ADBC and arrow-go use GitHub releases:

See also: #6929 (comment) and related comments in the issue.

@kou kou added the enhancement Any new improvement worthy of a entry in the changelog label Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Any new improvement worthy of a entry in the changelog
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant