Skip to content

Commit 1527e02

Browse files
bastelfreakbastelfreak
authored
Merge pull request #139 from bastelfreak/cleanup
Cleanup CI configuration, switch to trusted publishers
2 parents 5cbf7c2 + 5b9ec6b commit 1527e02

File tree

6 files changed

+148
-65
lines changed

6 files changed

+148
-65
lines changed

‎.github/release.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
3+
4+
changelog:
5+
exclude:
6+
labels:
7+
- duplicate
8+
- invalid
9+
- modulesync
10+
- question
11+
- skip-changelog
12+
- wont-fix
13+
- wontfix
14+
- github_actions
15+
16+
categories:
17+
- title: Breaking Changes 🛠
18+
labels:
19+
- backwards-incompatible
20+
21+
- title: New Features 🎉
22+
labels:
23+
- enhancement
24+
25+
- title: Bug Fixes 🐛
26+
labels:
27+
- bug
28+
- bugfix
29+
30+
- title: Documentation Updates 📚
31+
labels:
32+
- documentation
33+
- docs
34+
35+
- title: Dependency Updates ⬆️
36+
labels:
37+
- dependencies
38+
39+
- title: Other Changes
40+
labels:
41+
- "*"

‎.github/workflows/release.yml‎

Lines changed: 90 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,106 @@
1-
name: Release
1+
---
2+
name: Gem Release
23

34
on:
45
push:
56
tags:
67
- '*'
78

9+
permissions: {}
10+
811
jobs:
9-
release:
10-
runs-on: ubuntu-latest
12+
build-release:
13+
# Prevent releases from forked repositories
1114
if: github.repository_owner == 'voxpupuli'
15+
name: Build the gem
16+
runs-on: ubuntu-24.04
1217
steps:
1318
- uses: actions/checkout@v4
14-
- name: Install Ruby 3.4
19+
- name: Install Ruby
1520
uses: ruby/setup-ruby@v1
1621
with:
17-
ruby-version: '3.4'
18-
env:
19-
BUNDLE_WITHOUT: release
22+
ruby-version: 'ruby'
2023
- name: Build gem
21-
run: gem build --strict --verbose *.gemspec
24+
shell: bash
25+
run: gem build --verbose *.gemspec
26+
- name: Upload gem to GitHub cache
27+
uses: actions/upload-artifact@v4
28+
with:
29+
name: gem-artifact
30+
path: '*.gem'
31+
retention-days: 1
32+
compression-level: 0
33+
34+
create-github-release:
35+
needs: build-release
36+
name: Create GitHub release
37+
runs-on: ubuntu-24.04
38+
permissions:
39+
contents: write # clone repo and create release
40+
steps:
41+
- name: Download gem from GitHub cache
42+
uses: actions/download-artifact@v4
43+
with:
44+
name: gem-artifact
45+
- name: Create Release
46+
shell: bash
47+
env:
48+
GH_TOKEN: ${{ github.token }}
49+
run: gh release create --repo ${{ github.repository }} ${{ github.ref_name }} --generate-notes *.gem
50+
51+
release-to-github:
52+
needs: build-release
53+
name: Release to GitHub
54+
runs-on: ubuntu-24.04
55+
permissions:
56+
packages: write # publish to rubygems.pkg.github.com
57+
steps:
58+
- name: Download gem from GitHub cache
59+
uses: actions/download-artifact@v4
60+
with:
61+
name: gem-artifact
62+
- name: Publish gem to GitHub packages
63+
run: gem push --host https://rubygems.pkg.github.com/${{ github.repository_owner }} *.gem
64+
env:
65+
GEM_HOST_API_KEY: ${{ secrets.GITHUB_TOKEN }}
66+
67+
release-to-rubygems:
68+
needs: build-release
69+
name: Release gem to rubygems.org
70+
runs-on: ubuntu-24.04
71+
environment: release # recommended by rubygems.org
72+
permissions:
73+
id-token: write # rubygems.org authentication
74+
steps:
75+
- name: Download gem from GitHub cache
76+
uses: actions/download-artifact@v4
77+
with:
78+
name: gem-artifact
79+
- uses: rubygems/configure-rubygems-credentials@v1.0.0
2280
- name: Publish gem to rubygems.org
81+
shell: bash
2382
run: gem push *.gem
24-
env:
25-
GEM_HOST_API_KEY: '${{ secrets.RUBYGEMS_AUTH_TOKEN }}'
26-
- name: Setup GitHub packages access
83+
84+
release-verification:
85+
name: Check that all releases are done
86+
runs-on: ubuntu-24.04
87+
permissions:
88+
contents: read # minimal permissions that we have to grant
89+
needs:
90+
- create-github-release
91+
- release-to-github
92+
- release-to-rubygems
93+
steps:
94+
- name: Download gem from GitHub cache
95+
uses: actions/download-artifact@v4
96+
with:
97+
name: gem-artifact
98+
- name: Install Ruby
99+
uses: ruby/setup-ruby@v1
100+
with:
101+
ruby-version: 'ruby'
102+
- name: Wait for release to propagate
103+
shell: bash
27104
run: |
28-
mkdir -p ~/.gem
29-
echo ":github: Bearer ${{ secrets.GITHUB_TOKEN }}" >> ~/.gem/credentials
30-
chmod 0600 ~/.gem/credentials
31-
- name: Publish gem to GitHub packages
32-
run: gem push --key github --host https://rubygems.pkg.github.com/voxpupuli *.gem
105+
gem install rubygems-await
106+
gem await *.gem

‎.github/workflows/test.yml‎

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
---
12
name: Test
23

34
on:
@@ -6,12 +7,15 @@ on:
67
branches:
78
- master
89

9-
env:
10-
BUNDLE_WITHOUT: release
10+
# minimal permissions
11+
permissions:
12+
contents: read
1113

1214
jobs:
13-
rubocop:
14-
runs-on: ubuntu-latest
15+
rubocop_and_matrix:
16+
runs-on: ubuntu-24.04
17+
outputs:
18+
ruby: ${{ steps.ruby.outputs.versions }}
1519
steps:
1620
- uses: actions/checkout@v4
1721
- name: Install Ruby ${{ matrix.ruby }}
@@ -21,22 +25,16 @@ jobs:
2125
bundler-cache: true
2226
- name: Run Rubocop
2327
run: bundle exec rake rubocop
28+
- id: ruby
29+
uses: voxpupuli/ruby-version@v1
2430

2531
rspec:
26-
runs-on: ubuntu-latest
32+
runs-on: ubuntu-24.04
33+
needs: rubocop_and_matrix
2734
strategy:
28-
fail-fast: true
35+
fail-fast: false
2936
matrix:
30-
include:
31-
- ruby: "2.7"
32-
- ruby: "3.0"
33-
- ruby: "3.1"
34-
- ruby: "3.2"
35-
coverage: "yes"
36-
- ruby: "3.3"
37-
- ruby: "3.4"
38-
env:
39-
COVERAGE: ${{ matrix.coverage }}
37+
ruby: ${{ fromJSON(needs.rubocop_and_matrix.outputs.ruby) }}
4038
name: RSpec - Ruby ${{ matrix.ruby }}
4139
steps:
4240
- uses: actions/checkout@v4
@@ -59,9 +57,9 @@ jobs:
5957

6058
tests:
6159
needs:
62-
- rubocop
60+
- rubocop_and_matrix
6361
- rspec
64-
runs-on: ubuntu-latest
62+
runs-on: ubuntu-24.04
6563
name: Test suite
6664
steps:
6765
- run: echo Test suite completed

‎Gemfile‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,7 @@ source 'https://rubygems.org'
22

33
gemspec
44

5-
group :release do
5+
group :release, optional: true do
66
gem 'faraday-retry', '~> 2.1', require: false
77
gem 'github_changelog_generator', '~> 1.16.4', require: false
88
end
9-
10-
group :coverage, optional: ENV['COVERAGE'] != 'yes' do
11-
gem 'codecov', require: false
12-
gem 'simplecov-console', require: false
13-
end

‎README.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ puppet-blacksmith
33

44
[![License](https://img.shields.io/github/license/voxpupuli/puppet-blacksmith.svg)](https://github.com/voxpupuli/puppet-blacksmith/blob/master/LICENSE)
55
[![Test](https://github.com/voxpupuli/puppet-blacksmith/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/puppet-blacksmith/actions/workflows/test.yml)
6-
[![codecov](https://codecov.io/gh/voxpupuli/puppet-blacksmith/branch/master/graph/badge.svg)](https://codecov.io/gh/voxpupuli/puppet-blacksmith)
76
[![Release](https://github.com/voxpupuli/puppet-blacksmith/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/puppet-blacksmith/actions/workflows/release.yml)
87
[![RubyGem Version](https://img.shields.io/gem/v/puppet-blacksmith.svg)](https://rubygems.org/gems/puppet-blacksmith)
98
[![RubyGem Downloads](https://img.shields.io/gem/dt/puppet-blacksmith.svg)](https://rubygems.org/gems/puppet-blacksmith)

‎spec/spec_helper.rb‎

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1 @@
1-
begin
2-
require 'simplecov'
3-
require 'simplecov-console'
4-
require 'codecov'
5-
rescue LoadError
6-
else
7-
SimpleCov.start do
8-
track_files 'lib/**/*.rb'
9-
10-
add_filter '/spec'
11-
12-
enable_coverage :branch
13-
14-
# do not track vendored files
15-
add_filter '/vendor'
16-
add_filter '/.vendor'
17-
end
18-
19-
SimpleCov.formatters = [
20-
SimpleCov::Formatter::Console,
21-
SimpleCov::Formatter::Codecov,
22-
]
23-
end
24-
251
require 'puppet_blacksmith'

0 commit comments

Comments
 (0)