Skip to content

Commit

Permalink
chore: Enable changelog tracking and releasing
Browse files Browse the repository at this point in the history
  • Loading branch information
anakinj committed Sep 20, 2024
1 parent d020fea commit 01efaba
Show file tree
Hide file tree
Showing 8 changed files with 89 additions and 8 deletions.
18 changes: 18 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

<!--
The title of the pull request should follow the structure of https://www.conventionalcommits.org/:
A few examples:
feat: Added support for X and Y
fix: Fixes a problem with Z
-->

### Description

This Pull Request changes/fixes/enhances this thing...

### Checklist

Before the PR can be merged be sure the following are checked:
* [ ] There are tests for the fix or feature added/changed
2 changes: 2 additions & 0 deletions .github/release-please.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
handleGHRelease: true
manifest: true
39 changes: 39 additions & 0 deletions .github/workflows/gem-push.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
'on':
push:
tags:
- v*
name: Push Gem
jobs:
push:
runs-on: ubuntu-latest
permissions:
contents: write
id-token: write
steps:
- uses: rubygems/configure-rubygems-credentials@main
with:
role-to-assume: rg_oidc_akr_kxofkh8hkqgjf3rpctjw
- uses: actions/checkout@v4
- name: Set remote URL
run: |
# Attribute commits to the last committer on HEAD
git config --global user.email "$(git log -1 --pretty=format:'%ae')"
git config --global user.name "$(git log -1 --pretty=format:'%an')"
git remote set-url origin "https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY"
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
bundler-cache: true
ruby-version: ruby
- name: Release
run: bundle exec rake release
- name: Wait for release to propagate
run: |
gem install rubygems-await
gem_tuple="$(ruby -rbundler/setup -rbundler -e '
spec = Bundler.definition.specs.find {|s| s.name == ARGV[0] }
raise "No spec for #{ARGV[0]}" unless spec
print [spec.name, spec.version, spec.platform].join(":")
' "jwt-kms")"
gem await "${gem_tuple}"
15 changes: 15 additions & 0 deletions .github/workflows/pr-title.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: PR Conventional Commit Validation

on:
pull_request:
types: [opened, synchronize, reopened, edited]

jobs:
validate-pr-title:
runs-on: ubuntu-latest
steps:
- name: PR Conventional Commit Validation
uses: ytanikin/[email protected]
with:
task_types: '["feat","fix","docs","test","ci","refactor","perf","chore","revert"]'
add_label: 'false'
3 changes: 3 additions & 0 deletions .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
".": "0.1.0"
}
5 changes: 0 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +0,0 @@
## [Unreleased]

## [0.1.0] - 2024-09-17

- Initial release
6 changes: 3 additions & 3 deletions jwt-kms.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
spec.authors = ["Joakim Antman"]
spec.email = ["[email protected]"]

spec.summary = "AWS KMS powered algorithms"
spec.description = "Signing and veification using aws-kms"
spec.summary = "AWS KMS algorithm extension for ruby-jwt"
spec.description = "Utilize AWS KMS to handle the signing and verification of JWT tokens"
spec.homepage = "https://github.com/anakinj/jwt-kms"
spec.license = "MIT"
spec.required_ruby_version = ">= 3.0.0"
Expand All @@ -18,7 +18,7 @@ Gem::Specification.new do |spec|

spec.metadata["homepage_uri"] = spec.homepage
spec.metadata["source_code_uri"] = "https://github.com/anakinj/jwt-kms"
spec.metadata["changelog_uri"] = "https://github.com/anakinj/jwt-kms"
spec.metadata["changelog_uri"] = "https://github.com/anakinj/jwt-kms/blob/v#{JWT::EdDSA::VERSION}/CHANGELOG.md"

# Specify which files should be added to the gem when it is released.
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
Expand Down
9 changes: 9 additions & 0 deletions release-please-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"release-type": "ruby",
"include-v-in-tag": true,
"packages": {
".": {
"version-file": "lib/jwt/kms/version.rb"
}
}
}

0 comments on commit 01efaba

Please sign in to comment.