Skip to content

Commit

Permalink
Merge pull request #1475 from octokit/timrogers/release
Browse files Browse the repository at this point in the history
Tweak release documentation and process
  • Loading branch information
nickfloyd authored Sep 6, 2022
2 parents bae18d2 + 9aef9ef commit ec2f429
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
8 changes: 3 additions & 5 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@
4. (optional, but nice) Sort into logical buckets, like "support for additional endpoints", "enhancements", "bugfixes"
5. Reorganize to put the pull request number at the start of the line
2. Ensure there are no breaking changes _(if there are breaking changes you'll need to create a release branch without those changes or bump the major version)_
3. Update the version
1. Update the constant in `lib/octokit/version.rb`
2. Commit the version change and push directly to master
4. (Optional) Run `script/release` with no parameters to execute a dry run of a release
5. Run the `script/release -r` script to cut a release (this will run `script/validate` to perform the permission check)
3. Update the version in `lib/octokit/version.rb`
4. Run `script/release` with no parameters to execute a dry run of a release
5. Run the `script/release -r` script to cut a release. This will perform some sanity checks on permissions, build the gem into a `.gem` file, create a commit for your new version, tag the commit with the new version, push the commit and tag to GitHub and finally push the gem to RubyGems.
6. Draft a new release at https://github.com/octokit/octokit.rb/releases/new containing the curated changelog

----
Expand Down
4 changes: 2 additions & 2 deletions script/release
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@ else
./script/package

# We need to pull the version from the actual file that is about to be published
file=$(ls pkg/*.gem| head -1)
file=$(ls pkg/*.gem | sort | tail -1)
version=$(echo $file | sed -e 's/.*octokit-\(.*\).gem.*/\1/')

[ -n "$version" ] || exit 1

echo "*** Tagging and publishing $version of octokit ***"

git commit --allow-empty -a -m "Release $version"
git commit --allow-empty -a -m "v$version"
git tag "v$version"
git push origin
git push origin "v$version"
Expand Down

0 comments on commit ec2f429

Please sign in to comment.