Skip to content

Document that release notes are generated from pull requests #1120

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.

Sign up for GitHub

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

Merged
joshuay03 merged 2 commits into from
Oct 16, 2026
Merged

Document that release notes are generated from pull requests #1120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff13a11
Document that release notes are generated from pull requests
joshuay03 Oct 16, 2026
2a7b24c
End every Publishing the Gem step with a period
joshuay03 Oct 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,9 @@ git rebase upstream/master
git push origin my-feature-branch -f
```

#### Update CHANGELOG
#### Release Notes

Update the [CHANGELOG](../CHANGELOG.md) with a description of what you have changed.
Release notes are generated from the titles of merged pull requests, so give your pull request a title that describes the change. There is no need to update the [CHANGELOG](../CHANGELOG.md); maintainers update it when releasing.

#### Check on Your Pull Request

Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,8 +363,8 @@ best practice is to depend on `concurrent-ruby` and let users to decide if they

### Publishing the Gem

* Update `version.rb`
* Update the CHANGELOG
* Update `version.rb`.
* Update the CHANGELOG with a section for the new version linking to its GitHub release notes.
* Add the new version to `docs-source/signpost.md`. Needs to be done only if there are visible changes in the documentation.
* Commit (and push) the changes.
* Use `bundle exec rake release` to release the gem.
Expand Down
Loading