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.

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

Jump to bottom

Document steps for releasing a new version of the gem #1285

Merged
merged 1 commit into from
Sep 3, 2024
Merged

Document steps for releasing a new version of the gem #1285

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,30 @@ Then at the PSQL command line:

`template1=# CREATE EXTENSION IF NOT EXISTS "uuid-ossp";`

## Releasing

1. Read the CHANGELOG.md and decide on the new semantic version number
1. Create a release branch, eg. `release-96.0.3`
1. Update the CHANGELOG.md
- Declare a new version number
- Move all unreleased changes beneath it
1. Update `lib/gds_api/version.rb` to match, eg

```ruby
module GdsApi
VERSION = "96.0.3".freeze
end
```

1. Copy the lines from the CHANGELOG.md into the git commit
1. Propose and merge the pull request into `main`

Nb:

- You do not need to set any git tags
- After merging, CI will release the new version of the gem and Dependabot will
Copy link
Contributor Author

@tahb tahb Aug 30, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Does anyone know how long Dependabot tends to take?

Copy link
Contributor

Choose a reason for hiding this comment

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

No unfortunately I don't 😞

propose the new version of the gem to help distribute the changes to consumers

## Licence

Released under the MIT Licence, a copy of which can be found in the file
Expand Down