Skip to content

Commit

Permalink
Release 15.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredbeck committed Oct 22, 2023
1 parent 8d108c9 commit 47dbc22
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 35 deletions.
27 changes: 12 additions & 15 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,30 +101,27 @@ markdown-toc -i --maxdepth 3 --bullets='-' README.md

## Releases

1. Prepare the appropriate "stable" branch for release, eg. `10-stable`
1. git checkout 10-stable
1. Checkout a new branch, eg. `release-10.3.0`
1. Merge the relevant changes from `master`. This could be a plain merge, or
it could be cherry-picking. The later is more common in backports.
The X-stable branches, e.g. 15-stable, are no longer maintained; not worth the
effort given that we only maintain the latest version. Ie. haven't done a
backport in a very long time.

1. Prepare release PR
1. Checkout a new branch, eg. `release-15.1.0`
1. Merge the relevant changes from `master`
1. Set the version in `lib/paper_trail/version_number.rb`
1. In the changelog,
- Replace "Unreleased" with the date in ISO-8601 format
- Add a new "Unreleased" section
1. In the readme, update references to version number, including
- list of documentation versions
- compatability table, if necessary
1. git commit -am 'Release 10.3.0'
1. git push -u origin release-10.3.0
1. Pull request into `10-stable`, CI pass, merge PR
1. git commit -am 'Release 15.1.0'
1. git push -u origin release-15.1.0
1. Pull request into `master`, CI pass, merge PR
1. Release
1. git checkout 10-stable && git pull
1. gem build paper_trail.gemspec
1. gem push paper_trail-10.3.0.gem
1. git tag -a -m "v10.3.0" "v10.3.0" # or whatever number
1. gem push paper_trail-15.1.0.gem
1. git tag -a -m "v15.1.0" "v15.1.0" # or whatever number
1. git push --tags origin
1. Cleanup
1. git checkout master
1. cherry-pick the "Release 10.3.0" commit from the `10-stable` branch
1. git push origin master

[1]: https://github.com/paper-trail-gem/paper_trail/blob/master/.github/ISSUE_TEMPLATE/bug-report.md
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@ recommendations of [keepachangelog.com](http://keepachangelog.com/).

- None

### Added

- None

### Fixed

- None

## 15.1.0 (2023-10-22)

### Breaking Changes

- None

### Fixed

- None
Expand Down
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This is the _user guide_. See also, the

Choose version:
[Unreleased](https://github.com/paper-trail-gem/paper_trail/blob/master/README.md),
[15.0](https://github.com/paper-trail-gem/paper_trail/blob/v15.0.0/README.md),
[15.1](https://github.com/paper-trail-gem/paper_trail/blob/v15.1.0/README.md),
[14.0](https://github.com/paper-trail-gem/paper_trail/blob/v14.0.0/README.md),
[13.0](https://github.com/paper-trail-gem/paper_trail/blob/v13.0.0/README.md),
[12.3](https://github.com/paper-trail-gem/paper_trail/blob/v12.3.0/README.md),
Expand Down Expand Up @@ -90,24 +90,24 @@ Choose version:

### 1.a. Compatibility

| paper_trail | branch | ruby | activerecord |
|-------------|------------|----------|---------------|
| unreleased | master | >= 3.0.0 | >= 6.1, < 7.2 |
| 15 | 15-stable | >= 3.0.0 | >= 6.1, < 7.1 |
| 14 | 14-stable | >= 2.7.0 | >= 6.0, < 7.1 |
| 13 | 13-stable | >= 2.6.0 | >= 5.2, < 7.1 |
| 12 | 12-stable | >= 2.6.0 | >= 5.2, < 7.1 |
| 11 | 11-stable | >= 2.4.0 | >= 5.2, < 6.1 |
| 10 | 10-stable | >= 2.3.0 | >= 4.2, < 6.1 |
| 9 | 9-stable | >= 2.3.0 | >= 4.2, < 5.3 |
| 8 | 8-stable | >= 2.2.0 | >= 4.2, < 5.2 |
| 7 | 7-stable | >= 2.1.0 | >= 4.0, < 5.2 |
| 6 | 6-stable | >= 1.9.3 | >= 4.0, < 5.2 |
| 5 | 5-stable | >= 1.9.3 | >= 3.0, < 5.1 |
| 4 | 4-stable | >= 1.8.7 | >= 3.0, < 5.1 |
| 3 | 3.0-stable | >= 1.8.7 | >= 3.0, < 5 |
| 2 | 2.7-stable | >= 1.8.7 | >= 3.0, < 4 |
| 1 | rails2 | >= 1.8.7 | >= 2.3, < 3 |
| paper_trail | ruby | activerecord |
|-------------|----------|---------------|
| unreleased | >= 3.0.0 | >= 6.1, < 7.2 |
| 15 | >= 3.0.0 | >= 6.1, < 7.2 |
| 14 | >= 2.7.0 | >= 6.0, < 7.1 |
| 13 | >= 2.6.0 | >= 5.2, < 7.1 |
| 12 | >= 2.6.0 | >= 5.2, < 7.1 |
| 11 | >= 2.4.0 | >= 5.2, < 6.1 |
| 10 | >= 2.3.0 | >= 4.2, < 6.1 |
| 9 | >= 2.3.0 | >= 4.2, < 5.3 |
| 8 | >= 2.2.0 | >= 4.2, < 5.2 |
| 7 | >= 2.1.0 | >= 4.0, < 5.2 |
| 6 | >= 1.9.3 | >= 4.0, < 5.2 |
| 5 | >= 1.9.3 | >= 3.0, < 5.1 |
| 4 | >= 1.8.7 | >= 3.0, < 5.1 |
| 3 | >= 1.8.7 | >= 3.0, < 5 |
| 2 | >= 1.8.7 | >= 3.0, < 4 |
| 1 | >= 1.8.7 | >= 2.3, < 3 |

Experts: to install incompatible versions of activerecord, see
`paper_trail/compatibility.rb`.
Expand Down
2 changes: 1 addition & 1 deletion lib/paper_trail/version_number.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ module PaperTrail
# People are encouraged to use `PaperTrail.gem_version` instead.
module VERSION
MAJOR = 15
MINOR = 0
MINOR = 1
TINY = 0

# Set PRE to nil unless it's a pre-release (beta, rc, etc.)
Expand Down

0 comments on commit 47dbc22

Please sign in to comment.