github_pages_rake_tasks 1.0.1 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b3c5c3e5126302ca5598c30db6a85a0c6b1f67b0e6428ed9615db21b918c759b
4
- data.tar.gz: b220f11154955af1369048d065149bcd269471b6de7a2a417edb16856833b43d
3
+ metadata.gz: f7ffbe030de2443b4266b88222b233c3ff9808596a1cf6f1f45c8a8701c0f495
4
+ data.tar.gz: 75086349970c0e2ae6f396644a91e778edf2546b1da8db7fee7542206177479c
5
5
  SHA512:
6
- metadata.gz: 36b7137f3d6a34ab4be0808204590c572b05af052778cab2593bd6c81f3803a703d63fb842571c98fc4223caeb1a6bb79298c79573e4e0d506905e0fc48f7da4
7
- data.tar.gz: 3519eb9f421455e7f41776fc6ea1bc92f1e7bf5467578c0dea63fbc343aaeb03a81dd21dc6d3b210042e8cf9db2124f9b900202373c1b78092cf465f8df690a3
6
+ metadata.gz: 5642e9f049b05b93adb9de16c95fba91a51923631a9a22b8378b7eb718af9d678d1cdce46c9dba78394dd8f7905411d9b85d7e1cb329ac152c7e3fa147ae3fe5
7
+ data.tar.gz: d98bc9deff332011d9f871ddffe645772360d7926355e498e333abcf3060129bf3204278574618e0081486afbea03c9eff0f7e91caf4e36fe22182c33240f8b1
data/.commitlintrc.yml ADDED
@@ -0,0 +1,37 @@
1
+ ---
2
+ extends: '@commitlint/config-conventional'
3
+
4
+ rules:
5
+ # See: https://commitlint.js.org/reference/rules.html
6
+ #
7
+ # Rules are made up by a name and a configuration array. The configuration
8
+ # array contains:
9
+ #
10
+ # * Severity [0..2]: 0 disable rule, 1 warning if violated, or 2 error if
11
+ # violated
12
+ # * Applicability [always|never]: never inverts the rule
13
+ # * Value: value to use for this rule (if applicable)
14
+ #
15
+ # Run `npx commitlint --print-config` to see the current setting for all
16
+ # rules.
17
+ #
18
+ header-max-length: [2, always, 100] # Header can not exceed 100 chars
19
+
20
+ type-case: [2, always, lower-case] # Type must be lower case
21
+ type-empty: [2, never] # Type must not be empty
22
+
23
+ # Supported conventional commit types
24
+ type-enum: [2, always, [build, ci, chore, docs, feat, fix, perf, refactor, revert, style, test]]
25
+
26
+ scope-case: [2, always, lower-case] # Scope must be lower case
27
+
28
+ # Error if subject is one of these cases (encourages lower-case)
29
+ subject-case: [2, never, [sentence-case, start-case, pascal-case, upper-case]]
30
+ subject-empty: [2, never] # Subject must not be empty
31
+ subject-full-stop: [2, never, "."] # Subject must not end with a period
32
+
33
+ body-leading-blank: [2, always] # Body must have a blank line before it
34
+ body-max-line-length: [2, always, 100] # Body lines can not exceed 100 chars
35
+
36
+ footer-leading-blank: [2, always] # Footer must have a blank line before it
37
+ footer-max-line-length: [2, always, 100] # Footer lines can not exceed 100 chars
@@ -0,0 +1,41 @@
1
+ name: Continuous Integration
2
+
3
+ on:
4
+ pull_request:
5
+ branches: [main]
6
+
7
+ workflow_dispatch:
8
+
9
+ jobs:
10
+ build:
11
+ name: Ruby ${{ matrix.ruby }} on ${{ matrix.operating-system }}
12
+
13
+ if: >-
14
+ github.event_name == 'workflow_dispatch' ||
15
+ (github.event_name == 'pull_request' && !startsWith(github.event.pull_request.head.ref, 'release-please--'))
16
+
17
+ runs-on: ${{ matrix.operating-system }}
18
+ continue-on-error: true
19
+
20
+ env:
21
+ FAIL_ON_LOW_COVERAGE: ${{ matrix.fail_on_low_coverage }}
22
+
23
+ strategy:
24
+ fail-fast: false
25
+ matrix:
26
+ ruby: ["3.1", "3.4"]
27
+ operating-system: [ubuntu-latest]
28
+ fail_on_low_coverage: [true]
29
+
30
+ steps:
31
+ - name: Checkout
32
+ uses: actions/checkout@v4
33
+
34
+ - name: Initialize Ruby
35
+ uses: ruby/setup-ruby@v1
36
+ with:
37
+ ruby-version: ${{ matrix.ruby }}
38
+ bundler-cache: true
39
+
40
+ - name: Run rake
41
+ run: bundle exec rake
@@ -0,0 +1,30 @@
1
+ ---
2
+ name: Conventional Commits
3
+
4
+ permissions:
5
+ contents: read
6
+
7
+ on:
8
+ pull_request:
9
+ branches:
10
+ - main
11
+
12
+ jobs:
13
+ commit-lint:
14
+ name: Verify Conventional Commits
15
+
16
+ # Skip this job if this is a release PR
17
+ if: >-
18
+ github.event_name == 'workflow_dispatch' ||
19
+ (github.event_name == 'pull_request' && !startsWith(github.event.pull_request.head.ref, 'release-please--'))
20
+
21
+ runs-on: ubuntu-latest
22
+
23
+ steps:
24
+ - name: Checkout
25
+ uses: actions/checkout@v4
26
+ with: { fetch-depth: 0 }
27
+
28
+ - name: Check Commit Messages
29
+ uses: wagoid/commitlint-github-action@v6
30
+ with: { configFile: .commitlintrc.yml }
@@ -0,0 +1,51 @@
1
+ ---
2
+ name: Release Gem
3
+ description: |
4
+ This workflow creates a new release on GitHub and publishes the gem to
5
+ RubyGems.org.
6
+
7
+ The workflow uses the `googleapis/release-please-action` to handle the
8
+ release creation process and the `rubygems/release-gem` action to publish
9
+ the gem.
10
+
11
+ on:
12
+ push:
13
+ branches: ["main"]
14
+
15
+ workflow_dispatch:
16
+
17
+ jobs:
18
+ release:
19
+ runs-on: ubuntu-latest
20
+
21
+ environment:
22
+ name: RubyGems
23
+ url: https://rubygems.org/gems/process_executer
24
+
25
+ permissions:
26
+ contents: write
27
+ pull-requests: write
28
+ id-token: write
29
+
30
+ steps:
31
+ - name: Checkout project
32
+ uses: actions/checkout@v4
33
+
34
+ - name: Create release
35
+ uses: googleapis/release-please-action@v4
36
+ id: release
37
+ with:
38
+ token: ${{ secrets.AUTO_RELEASE_TOKEN }}
39
+ config-file: release-please-config.json
40
+ manifest-file: .release-please-manifest.json
41
+
42
+ - name: Setup ruby
43
+ uses: ruby/setup-ruby@v1
44
+ if: ${{ steps.release.outputs.release_created }}
45
+ with:
46
+ bundler-cache: true
47
+ ruby-version: ruby
48
+
49
+ - name: Push to RubyGems.org
50
+ uses: rubygems/release-gem@v1
51
+ if: ${{ steps.release.outputs.release_created }}
@@ -0,0 +1,3 @@
1
+ {
2
+ ".": "1.0.4"
3
+ }
data/.rubocop.yml CHANGED
@@ -7,7 +7,7 @@ AllCops:
7
7
  SuggestExtensions: false
8
8
  # RuboCop enforces rules depending on the oldest version of Ruby which
9
9
  # your project supports:
10
- TargetRubyVersion: 3.0
10
+ TargetRubyVersion: 3.1
11
11
 
12
12
  Gemspec/DevelopmentDependencies:
13
13
  EnforcedStyle: gemspec
data/CHANGELOG.md CHANGED
@@ -4,6 +4,27 @@ Changes for each release are listed in this file. Changes prior to v1.0.0 were n
4
4
 
5
5
  This project adheres to [Semantic Versioning](https://semver.org/) for its releases.
6
6
 
7
+ ## [1.0.4](https://github.com/main-branch/github_pages_rake_tasks/compare/v1.0.3...v1.0.4) (2025-04-18)
8
+
9
+
10
+ ### Other Changes
11
+
12
+ * Configure release-please to includes all changes in the CHANGELOG ([9586d0a](https://github.com/main-branch/github_pages_rake_tasks/commit/9586d0a91975d221846a3b69c7c0e9a012dd0c77))
13
+
14
+ ## [1.0.3](https://github.com/main-branch/github_pages_rake_tasks/compare/v1.0.2...v1.0.3) (2025-04-17)
15
+
16
+
17
+ ### Bug Fixes
18
+
19
+ * Do not trigger build workflows after merging to main or for release PRs ([#31](https://github.com/main-branch/github_pages_rake_tasks/issues/31)) ([9acf1c9](https://github.com/main-branch/github_pages_rake_tasks/commit/9acf1c923df2ff32b632ef3c3d56dd9a1591c547))
20
+
21
+ ## [1.0.2](https://github.com/main-branch/github_pages_rake_tasks/compare/v1.0.1...v1.0.2) (2025-04-16)
22
+
23
+
24
+ ### Bug Fixes
25
+
26
+ * Automate commit-to-publish workflow ([#29](https://github.com/main-branch/github_pages_rake_tasks/issues/29)) ([90e3919](https://github.com/main-branch/github_pages_rake_tasks/commit/90e3919a1566b0123dacc95165cc0f0916736e7b))
27
+
7
28
  ## v1.0.1 (2023-12-11)
8
29
 
9
30
  [Full Changelog](https://github.com/main-branch/github_pages_rake_tasks/compare/v1.0.0..v1.0.1)
data/README.md CHANGED
@@ -4,8 +4,6 @@
4
4
  [![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/github_pages_rake_tasks/)
5
5
  [![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/github_pages_rake_tasks/file/CHANGELOG.md)
6
6
  [![Build Status](https://github.com/main-branch/github_pages_rake_tasks/workflows/CI%20Build/badge.svg?branch=main)](https://github.com/main-branch/github_pages_rake_tasks/actions?query=workflow%3ACI%20Build)
7
- [![Maintainability](https://api.codeclimate.com/v1/badges/a67ad0b61d3687e33181/maintainability)](https://codeclimate.com/github/main-branch/github_pages_rake_tasks/maintainability)
8
- [![Test Coverage](https://api.codeclimate.com/v1/badges/a67ad0b61d3687e33181/test_coverage)](https://codeclimate.com/github/main-branch/github_pages_rake_tasks/test_coverage)
9
7
 
10
8
  The `github_pages_rake_tasks` gem creates a rake task that pushes files
11
9
  from a local documentation directory to a remote Git repository branch.
data/Rakefile CHANGED
@@ -26,6 +26,13 @@ rescue Bundler::BundlerError => e
26
26
  exit e.status_code
27
27
  end
28
28
 
29
+ # Make it so that calling `rake release` just calls `rake release:rubygems_push` to
30
+ # avoid creating and pushing a new tag.
31
+
32
+ Rake::Task['release'].clear
33
+ desc 'Customized release task to avoid creating a new tag'
34
+ task release: 'release:rubygem_push'
35
+
29
36
  CLEAN << 'pkg'
30
37
  CLEAN << 'Gemfile.lock'
31
38
 
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
23
23
 
24
24
  spec.homepage = 'https://github.com/jcouball/github_pages_rake_tasks'
25
25
  spec.license = 'MIT'
26
- spec.required_ruby_version = '>= 3.0.0'
26
+ spec.required_ruby_version = '>= 3.1.0'
27
27
 
28
28
  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
29
29
  spec.metadata['rubygems_mfa_required'] = 'true'
@@ -42,10 +42,10 @@ Gem::Specification.new do |spec|
42
42
  spec.require_paths = ['lib']
43
43
 
44
44
  spec.add_development_dependency 'bundler-audit', '~> 0.9'
45
- spec.add_development_dependency 'rake', '~> 13.1'
46
- spec.add_development_dependency 'rspec', '~> 3.12'
47
- spec.add_development_dependency 'rubocop', '~> 1.58'
48
- spec.add_development_dependency 'semverify', '0.3.0'
45
+ spec.add_development_dependency 'rake', '~> 13.2'
46
+ spec.add_development_dependency 'rspec', '~> 3.13'
47
+ spec.add_development_dependency 'rubocop', '~> 1.75'
48
+ spec.add_development_dependency 'semverify', '~> 0.3'
49
49
  spec.add_development_dependency 'simplecov', '~> 0.22'
50
50
  spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
51
51
 
@@ -3,5 +3,5 @@
3
3
 
4
4
  module GithubPagesRakeTasks
5
5
  # Version of this module
6
- VERSION = '1.0.1'
6
+ VERSION = '1.0.4'
7
7
  end
@@ -0,0 +1,36 @@
1
+ {
2
+ "bootstrap-sha": "63e60714532721c2f407d6c15d7f80d4b3062db8",
3
+ "packages": {
4
+ ".": {
5
+ "release-type": "ruby",
6
+ "package-name": "github_pages_rake_tasks",
7
+ "changelog-path": "CHANGELOG.md",
8
+ "version-file": "lib/github_pages_rake_tasks/version.rb",
9
+ "bump-minor-pre-major": true,
10
+ "bump-patch-for-minor-pre-major": true,
11
+ "draft": false,
12
+ "prerelease": false,
13
+ "include-component-in-tag": false,
14
+ "pull-request-title-pattern": "chore: release v${version}",
15
+ "changelog-sections": [
16
+ { "type": "feat", "section": "Features", "hidden": false },
17
+ { "type": "fix", "section": "Bug Fixes", "hidden": false },
18
+ { "type": "build", "section": "Other Changes", "hidden": false },
19
+ { "type": "chore", "section": "Other Changes", "hidden": false },
20
+ { "type": "ci", "section": "Other Changes", "hidden": false },
21
+ { "type": "docs", "section": "Other Changes", "hidden": false },
22
+ { "type": "perf", "section": "Other Changes", "hidden": false },
23
+ { "type": "refactor", "section": "Other Changes", "hidden": false },
24
+ { "type": "revert", "section": "Other Changes", "hidden": false },
25
+ { "type": "style", "section": "Other Changes", "hidden": false },
26
+ { "type": "test", "section": "Other Changes", "hidden": false }
27
+ ]
28
+ }
29
+ },
30
+ "plugins": [
31
+ {
32
+ "type": "sentence-case"
33
+ }
34
+ ],
35
+ "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
36
+ }
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: github_pages_rake_tasks
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.1
4
+ version: 1.0.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - James Couball
8
- autorequire:
9
8
  bindir: exe
10
9
  cert_chain: []
11
- date: 2023-12-12 00:00:00.000000000 Z
10
+ date: 1980-01-02 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: bundler-audit
@@ -30,56 +29,56 @@ dependencies:
30
29
  requirements:
31
30
  - - "~>"
32
31
  - !ruby/object:Gem::Version
33
- version: '13.1'
32
+ version: '13.2'
34
33
  type: :development
35
34
  prerelease: false
36
35
  version_requirements: !ruby/object:Gem::Requirement
37
36
  requirements:
38
37
  - - "~>"
39
38
  - !ruby/object:Gem::Version
40
- version: '13.1'
39
+ version: '13.2'
41
40
  - !ruby/object:Gem::Dependency
42
41
  name: rspec
43
42
  requirement: !ruby/object:Gem::Requirement
44
43
  requirements:
45
44
  - - "~>"
46
45
  - !ruby/object:Gem::Version
47
- version: '3.12'
46
+ version: '3.13'
48
47
  type: :development
49
48
  prerelease: false
50
49
  version_requirements: !ruby/object:Gem::Requirement
51
50
  requirements:
52
51
  - - "~>"
53
52
  - !ruby/object:Gem::Version
54
- version: '3.12'
53
+ version: '3.13'
55
54
  - !ruby/object:Gem::Dependency
56
55
  name: rubocop
57
56
  requirement: !ruby/object:Gem::Requirement
58
57
  requirements:
59
58
  - - "~>"
60
59
  - !ruby/object:Gem::Version
61
- version: '1.58'
60
+ version: '1.75'
62
61
  type: :development
63
62
  prerelease: false
64
63
  version_requirements: !ruby/object:Gem::Requirement
65
64
  requirements:
66
65
  - - "~>"
67
66
  - !ruby/object:Gem::Version
68
- version: '1.58'
67
+ version: '1.75'
69
68
  - !ruby/object:Gem::Dependency
70
69
  name: semverify
71
70
  requirement: !ruby/object:Gem::Requirement
72
71
  requirements:
73
- - - '='
72
+ - - "~>"
74
73
  - !ruby/object:Gem::Version
75
- version: 0.3.0
74
+ version: '0.3'
76
75
  type: :development
77
76
  prerelease: false
78
77
  version_requirements: !ruby/object:Gem::Requirement
79
78
  requirements:
80
- - - '='
79
+ - - "~>"
81
80
  - !ruby/object:Gem::Version
82
- version: 0.3.0
81
+ version: '0.3'
83
82
  - !ruby/object:Gem::Dependency
84
83
  name: simplecov
85
84
  requirement: !ruby/object:Gem::Requirement
@@ -169,9 +168,13 @@ executables: []
169
168
  extensions: []
170
169
  extra_rdoc_files: []
171
170
  files:
171
+ - ".commitlintrc.yml"
172
172
  - ".github/CODEOWNERS"
173
- - ".github/workflows/main.yml"
173
+ - ".github/workflows/continuous_integration.yml"
174
+ - ".github/workflows/enforce_conventional_commits.yml"
175
+ - ".github/workflows/release.yml"
174
176
  - ".gitignore"
177
+ - ".release-please-manifest.json"
175
178
  - ".rspec"
176
179
  - ".rubocop.yml"
177
180
  - ".yardopts"
@@ -188,6 +191,7 @@ files:
188
191
  - lib/github_pages_rake_tasks/publish_task.rb
189
192
  - lib/github_pages_rake_tasks/state.rb
190
193
  - lib/github_pages_rake_tasks/version.rb
194
+ - release-please-config.json
191
195
  homepage: https://github.com/jcouball/github_pages_rake_tasks
192
196
  licenses:
193
197
  - MIT
@@ -197,7 +201,6 @@ metadata:
197
201
  homepage_uri: https://github.com/jcouball/github_pages_rake_tasks
198
202
  source_code_uri: https://github.com/jcouball/github_pages_rake_tasks
199
203
  changelog_uri: https://github.com/jcouball/github_pages_rake_tasks
200
- post_install_message:
201
204
  rdoc_options: []
202
205
  require_paths:
203
206
  - lib
@@ -205,15 +208,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
205
208
  requirements:
206
209
  - - ">="
207
210
  - !ruby/object:Gem::Version
208
- version: 3.0.0
211
+ version: 3.1.0
209
212
  required_rubygems_version: !ruby/object:Gem::Requirement
210
213
  requirements:
211
214
  - - ">="
212
215
  - !ruby/object:Gem::Version
213
216
  version: '0'
214
217
  requirements: []
215
- rubygems_version: 3.4.10
216
- signing_key:
218
+ rubygems_version: 3.6.7
217
219
  specification_version: 4
218
220
  summary: Rake tasks for publishing documentation to GitHub Pages
219
221
  test_files: []
@@ -1,64 +0,0 @@
1
- name: CI Build
2
-
3
- on:
4
- push:
5
- branches: [ main ]
6
-
7
- pull_request:
8
- branches: [ main ]
9
-
10
- jobs:
11
- build:
12
- continue-on-error: true
13
-
14
- strategy:
15
- matrix:
16
- ruby: ['3.0', '3.2', head, jruby-head]
17
- operating-system: [ubuntu-latest]
18
- include:
19
- - ruby: '3.0'
20
- operating-system: windows-latest
21
- - ruby: jruby-head
22
- operating-system: windows-latest
23
-
24
- name: Ruby ${{ matrix.ruby }} on ${{ matrix.operating-system }}
25
- runs-on: ${{ matrix.operating-system }}
26
-
27
- steps:
28
- - name: Checkout
29
- uses: actions/checkout@v3
30
-
31
- - name: Initialize Ruby
32
- uses: ruby/setup-ruby@v1
33
- with:
34
- ruby-version: ${{ matrix.ruby }}
35
- bundler-cache: true
36
-
37
- - name: Run rake
38
- run: bundle exec rake
39
-
40
- coverage:
41
- needs: [ build ]
42
- runs-on: ubuntu-latest
43
-
44
- name: Report test coverage to CodeClimate
45
-
46
- steps:
47
- - name: Checkout
48
- uses: actions/checkout@v3
49
-
50
- - name: Initialize Ruby
51
- uses: ruby/setup-ruby@v1
52
- with:
53
- ruby-version: 3.1
54
- bundler-cache: true
55
-
56
- - name: Run tests
57
- run: bundle exec rake spec
58
-
59
- - name: Report test coverage
60
- uses: paambaati/codeclimate-action@v3.2.0
61
- env:
62
- CC_TEST_REPORTER_ID: 997ddf9df5b99897b448d7a7a13e332d57f0e29754d9b9d1414aaee611759422
63
- with:
64
- coverageLocations: ${{github.workspace}}/coverage/lcov/*.lcov:lcov