makenew-rbgem 3.0.0 → 3.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +29 -7
- data/lib/makenew-rbgem/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 857b080b79229c5e7229cb01ef7416fa76c82cefe8470d185f4b8c4153b49772
|
4
|
+
data.tar.gz: f481270a9c6d2d4cf3177656200143ec9f3b336d193d0f53137e982416326ef3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bb703dee1023d3e1ea6f9046dea87833331d1059bb305fd202fc45473d0027c43e1aa2caaa71822d3ff3f9c3039541c1f394a131040bcf45bbd440a85205f135
|
7
|
+
data.tar.gz: 2d2387cbdc61f954c939391a392a677604eec5df69f38123d2846eb8fd154459bc759c2723027e83c1678d9b1b5ca3c45956d5b88da140001c3935a39a8d8f8b
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -17,22 +17,26 @@ Bootstrap a new Ruby gem in five minutes or less.
|
|
17
17
|
- [Standard] Ruby style guide, linter, and formatter.
|
18
18
|
- Productive and fun testing with [RSpec].
|
19
19
|
- Code coverage reporting with [SimpleCov].
|
20
|
-
-
|
20
|
+
- Fully automated version management and package publishing with [semantic-release].
|
21
|
+
- Continuous checks and tests with [GitHub Actions].
|
21
22
|
- [Keep a CHANGELOG].
|
22
23
|
- Consistent coding with [EditorConfig].
|
23
24
|
- Badges from [Shields.io].
|
25
|
+
- Start coding instantly with [GitHub Codespaces].
|
24
26
|
|
25
27
|
[bundler]: https://bundler.io/
|
26
28
|
[editorconfig]: https://editorconfig.org/
|
29
|
+
[gem release]: https://github.com/svenfuchs/gem-release
|
27
30
|
[github actions]: https://github.com/features/actions
|
31
|
+
[github codespaces]: https://github.com/features/codespaces
|
28
32
|
[keep a changelog]: https://keepachangelog.com/
|
29
33
|
[rspec]: https://rspec.info/
|
30
|
-
[rubygems.org]: https://rubygems.org/
|
31
34
|
[ruby]: https://www.ruby-lang.org/
|
35
|
+
[rubygems.org]: https://rubygems.org/
|
36
|
+
[semantic-release]: https://semantic-release.gitbook.io/semantic-release/
|
32
37
|
[shields.io]: https://shields.io/
|
33
38
|
[simplecov]: https://github.com/simplecov-ruby/simplecov
|
34
39
|
[standard]: https://github.com/testdouble/standard
|
35
|
-
[gem release]: https://github.com/svenfuchs/gem-release
|
36
40
|
|
37
41
|
### Bootstrapping a new project
|
38
42
|
|
@@ -171,12 +175,30 @@ $ bundle install
|
|
171
175
|
|
172
176
|
### Publishing
|
173
177
|
|
174
|
-
|
178
|
+
New versions are created with [gem release].
|
179
|
+
|
180
|
+
#### Automatic
|
181
|
+
|
182
|
+
New versions are released automatically with [semantic-release]
|
183
|
+
as long as commits follow the [Angular Commit Message Conventions].
|
175
184
|
|
176
|
-
|
185
|
+
[Angular Commit Message Conventions]: https://semantic-release.gitbook.io/semantic-release/#commit-message-format
|
186
|
+
[semantic-release]: https://semantic-release.gitbook.io/
|
187
|
+
|
188
|
+
#### Manual
|
189
|
+
|
190
|
+
Publish a new version by triggering a [version workflow_dispatch on GitHub Actions].
|
191
|
+
The `version` input will be passed to the `--version` option of `gem bump`.
|
192
|
+
|
193
|
+
This may be done on the web or using the [GitHub CLI] with
|
194
|
+
|
195
|
+
```
|
196
|
+
$ gh workflow run version.yml --raw-field version=<version>
|
197
|
+
```
|
177
198
|
|
178
199
|
[gem release]: https://github.com/svenfuchs/gem-release
|
179
|
-
[
|
200
|
+
[GitHub CLI]: https://cli.github.com/
|
201
|
+
[version workflow_dispatch on GitHub Actions]: https://github.com/makenew/rbgem/actions?query=workflow%3Aversion
|
180
202
|
|
181
203
|
## GitHub Actions
|
182
204
|
|
@@ -190,7 +212,7 @@ These must be set manually.
|
|
190
212
|
|
191
213
|
### Secrets for Optional GitHub Actions
|
192
214
|
|
193
|
-
The version and
|
215
|
+
The version, format, generate, and semantic-release GitHub actions
|
194
216
|
require a user with write access to the repository.
|
195
217
|
Set these additional secrets to enable the action:
|
196
218
|
|