gitmoji-regex 1.0.2 → 1.0.3
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 +4 -4
- checksums.yaml.gz.sig +0 -0
- data/CHANGELOG.md +30 -11
- data/CODE_OF_CONDUCT.md +79 -29
- data/CONTRIBUTING.md +134 -54
- data/README.md +452 -206
- data/REEK +0 -0
- data/RUBOCOP.md +71 -0
- data/SECURITY.md +12 -4
- data/checksums/gitmoji-regex-1.0.2.gem.sha256 +1 -0
- data/checksums/gitmoji-regex-1.0.2.gem.sha512 +1 -0
- data/checksums/gitmoji-regex-1.0.3.gem.sha256 +1 -0
- data/checksums/gitmoji-regex-1.0.3.gem.sha512 +1 -0
- data/lib/gitmoji/regex/reference.rb +43 -3
- data/lib/gitmoji/regex/version.rb +5 -1
- data/lib/gitmoji/regex.rb +17 -2
- data/sig/gitmoji/regex.rbs +27 -2
- data/src/gitmojis.json +11 -3
- data.tar.gz.sig +0 -0
- metadata +144 -80
- metadata.gz.sig +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c967f0d0d466c879cba242ada01ada45201cc99fe2eae63377e1e59626042740
|
|
4
|
+
data.tar.gz: 9b946d878c53ebbf3e6737dfc5eebda8c1b4249653cbd59dc52ecfac14a899dd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: '06798142077542c2ce1961da99f3c681ab8e4fc0983f3d94550d4e32997dac596924e3d506a132c1a02752678207923bc40bf030a0d25146c649d40176d08c1f'
|
|
7
|
+
data.tar.gz: 0a682fcc4ef673650351d97e348390eade5ad4a899ef8fca2b11bc0e23e0bebde635351e71f827f67f071da4d583c09dd7d3091ab47d5421a933382c1cf21d7a
|
checksums.yaml.gz.sig
CHANGED
|
Binary file
|
data/CHANGELOG.md
CHANGED
|
@@ -1,16 +1,32 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
All notable changes to this project will be documented in this file.
|
|
3
3
|
|
|
4
|
-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
5
|
-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
4
|
+
The format is based on [Keep a Changelog v1](https://keepachangelog.com/en/1.0.0/),
|
|
5
|
+
and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.0.0.html).
|
|
6
6
|
|
|
7
7
|
## [Unreleased]
|
|
8
8
|
### Added
|
|
9
9
|
### Changed
|
|
10
|
-
###
|
|
10
|
+
### Deprecated
|
|
11
11
|
### Removed
|
|
12
|
+
### Fixed
|
|
13
|
+
### Security
|
|
14
|
+
|
|
15
|
+
## [1.0.3] - 2025-08-20
|
|
16
|
+
- TAG: [v1.0.3][1.0.3t]
|
|
17
|
+
- COVERAGE: 100.00% -- 57/57 lines in 3 files
|
|
18
|
+
- BRANCH COVERAGE: 100.00% -- 4/4 branches in 3 files
|
|
19
|
+
- 100.00% documented
|
|
20
|
+
### Added
|
|
21
|
+
- New gitmoji "✈️"
|
|
22
|
+
- appraisal2 for improved testing platform coverage in CI
|
|
23
|
+
### Changed
|
|
24
|
+
- gem dependencies for local development
|
|
25
|
+
- centralized logos to logos.galtzo.com
|
|
26
|
+
- scripts to enforce git commit message style
|
|
12
27
|
|
|
13
28
|
## [1.0.2] - 2023-05-30
|
|
29
|
+
- TAG: [v1.0.2][1.0.2t]
|
|
14
30
|
### Added
|
|
15
31
|
- New gitmoji "🧵"
|
|
16
32
|
- New gitmoji "🦺"
|
|
@@ -56,11 +72,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
56
72
|
### Added
|
|
57
73
|
- Initial release
|
|
58
74
|
|
|
59
|
-
[Unreleased]: https://github.com/
|
|
60
|
-
[1.0.
|
|
61
|
-
[1.0.
|
|
62
|
-
[1.0.
|
|
63
|
-
[0.
|
|
64
|
-
[0.1
|
|
65
|
-
[0.
|
|
66
|
-
[0.1.
|
|
75
|
+
[Unreleased]: https://github.com/galtzo-floss/gitmoji-regex/compare/v1.0.3...HEAD
|
|
76
|
+
[1.0.3]: https://github.com/galtzo-floss/gitmoji-regex/compare/v1.0.2...v1.0.3
|
|
77
|
+
[1.0.3t]: https://gitlab.com/galtzo-floss/gitmoji-regex/-/tags/v1.0.3
|
|
78
|
+
[1.0.2]: https://github.com/galtzo-floss/gitmoji-regex/compare/v1.0.1...v1.0.2
|
|
79
|
+
[1.0.2t]: https://gitlab.com/galtzo-floss/gitmoji-regex/-/tags/v1.0.2
|
|
80
|
+
[1.0.1]: https://github.com/galtzo-floss/gitmoji-regex/compare/v1.0.0...v1.0.1
|
|
81
|
+
[1.0.0]: https://github.com/galtzo-floss/gitmoji-regex/compare/v0.1.3...v1.0.0
|
|
82
|
+
[0.1.3]: https://github.com/galtzo-floss/gitmoji-regex/compare/v0.1.2...v0.1.3
|
|
83
|
+
[0.1.2]: https://github.com/galtzo-floss/gitmoji-regex/compare/v0.1.1...v0.1.2
|
|
84
|
+
[0.1.1]: https://github.com/galtzo-floss/gitmoji-regex/compare/v0.1.0...v0.1.1
|
|
85
|
+
[0.1.0]: https://github.com/galtzo-floss/gitmoji-regex/compare/e71c6c3dad5bfd59ae2509531eaea3a16e21cb63...v0.1.0
|
data/CODE_OF_CONDUCT.md
CHANGED
|
@@ -2,83 +2,133 @@
|
|
|
2
2
|
|
|
3
3
|
## Our Pledge
|
|
4
4
|
|
|
5
|
-
We as members, contributors, and leaders pledge to make participation in our
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
10
|
+
identity and orientation.
|
|
6
11
|
|
|
7
|
-
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
8
14
|
|
|
9
15
|
## Our Standards
|
|
10
16
|
|
|
11
|
-
Examples of behavior that contributes to a positive environment for our
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
12
19
|
|
|
13
20
|
* Demonstrating empathy and kindness toward other people
|
|
14
21
|
* Being respectful of differing opinions, viewpoints, and experiences
|
|
15
22
|
* Giving and gracefully accepting constructive feedback
|
|
16
|
-
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
17
|
-
|
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
+
community
|
|
18
27
|
|
|
19
28
|
Examples of unacceptable behavior include:
|
|
20
29
|
|
|
21
|
-
* The use of sexualized language or imagery, and sexual attention or
|
|
22
|
-
|
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or advances of
|
|
31
|
+
any kind
|
|
23
32
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
24
33
|
* Public or private harassment
|
|
25
|
-
* Publishing others' private information, such as a physical or email
|
|
26
|
-
|
|
34
|
+
* Publishing others' private information, such as a physical or email address,
|
|
35
|
+
without their explicit permission
|
|
27
36
|
* Other conduct which could reasonably be considered inappropriate in a
|
|
28
37
|
professional setting
|
|
29
38
|
|
|
30
39
|
## Enforcement Responsibilities
|
|
31
40
|
|
|
32
|
-
Community leaders are responsible for clarifying and enforcing our standards of
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
33
45
|
|
|
34
|
-
Community leaders have the right and responsibility to remove, edit, or reject
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
35
50
|
|
|
36
51
|
## Scope
|
|
37
52
|
|
|
38
|
-
This Code of Conduct applies within all community spaces, and also applies when
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official email address,
|
|
56
|
+
posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
39
58
|
|
|
40
59
|
## Enforcement
|
|
41
60
|
|
|
42
|
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to the community leaders responsible for enforcement at
|
|
63
|
+
[![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact].
|
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
43
65
|
|
|
44
|
-
All community leaders are obligated to respect the privacy and security of the
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
45
68
|
|
|
46
69
|
## Enforcement Guidelines
|
|
47
70
|
|
|
48
|
-
Community leaders will follow these Community Impact Guidelines in determining
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
49
73
|
|
|
50
74
|
### 1. Correction
|
|
51
75
|
|
|
52
|
-
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
unprofessional or unwelcome in the community.
|
|
53
78
|
|
|
54
|
-
**Consequence**: A private, written warning from community leaders, providing
|
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
|
55
82
|
|
|
56
83
|
### 2. Warning
|
|
57
84
|
|
|
58
|
-
**Community Impact**: A violation through a single incident or series of
|
|
85
|
+
**Community Impact**: A violation through a single incident or series of
|
|
86
|
+
actions.
|
|
59
87
|
|
|
60
|
-
**Consequence**: A warning with consequences for continued behavior. No
|
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
|
93
|
+
ban.
|
|
61
94
|
|
|
62
95
|
### 3. Temporary Ban
|
|
63
96
|
|
|
64
|
-
**Community Impact**: A serious violation of community standards, including
|
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
sustained inappropriate behavior.
|
|
65
99
|
|
|
66
|
-
**Consequence**: A temporary ban from any sort of interaction or public
|
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
communication with the community for a specified period of time. No public or
|
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
+
Violating these terms may lead to a permanent ban.
|
|
67
105
|
|
|
68
106
|
### 4. Permanent Ban
|
|
69
107
|
|
|
70
|
-
**Community Impact**: Demonstrating a pattern of violation of community
|
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
71
111
|
|
|
72
|
-
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
113
|
+
community.
|
|
73
114
|
|
|
74
115
|
## Attribution
|
|
75
116
|
|
|
76
|
-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
77
|
-
available at
|
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
+
version 2.1, available at
|
|
119
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
78
120
|
|
|
79
|
-
Community Impact Guidelines were inspired by
|
|
80
|
-
|
|
81
|
-
[homepage]: https://www.contributor-covenant.org
|
|
121
|
+
Community Impact Guidelines were inspired by
|
|
122
|
+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
82
123
|
|
|
83
124
|
For answers to common questions about this code of conduct, see the FAQ at
|
|
84
|
-
https://www.contributor-covenant.org/faq. Translations are available at
|
|
125
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
126
|
+
[https://www.contributor-covenant.org/translations][translations].
|
|
127
|
+
|
|
128
|
+
[homepage]: https://www.contributor-covenant.org
|
|
129
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
130
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
131
|
+
[FAQ]: https://www.contributor-covenant.org/faq
|
|
132
|
+
[translations]: https://www.contributor-covenant.org/translations
|
|
133
|
+
[🚂maint-contact]: http://www.railsbling.com/contact
|
|
134
|
+
[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
|
data/CONTRIBUTING.md
CHANGED
|
@@ -1,63 +1,143 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
Bug reports and pull requests are welcome on GitHub at [https://github.com/pboling/gitmoji-regex][source]
|
|
4
|
-
. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
|
|
5
|
-
the [code of conduct][conduct].
|
|
6
|
-
|
|
7
|
-
To submit a patch, please fork the project and create a patch with tests. Once you're happy with it send a pull request!
|
|
8
|
-
|
|
9
|
-
## Detailed instructions on Submitting a Pull Request
|
|
10
|
-
|
|
11
|
-
1. [Fork the repository.][fork]
|
|
12
|
-
2. [Create a topic branch.][branch]
|
|
13
|
-
3. Add specs for your unimplemented feature or bug fix.
|
|
14
|
-
4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
|
|
15
|
-
5. Implement your feature or bug fix.
|
|
16
|
-
6. Run `bundle exec rake`. If your specs fail, return to step 5.
|
|
17
|
-
7. Run `open coverage/index.html`. If your changes are not completely covered
|
|
18
|
-
by your tests, return to step 3.
|
|
19
|
-
8. Add documentation for your feature or bug fix.
|
|
20
|
-
9. Commit and push your changes.
|
|
21
|
-
10. [Submit a pull request.][pr]
|
|
22
|
-
|
|
23
|
-
[fork]: http://help.github.com/fork-a-repo/
|
|
24
|
-
[branch]: http://learn.github.com/p/branching.html
|
|
25
|
-
[pr]: http://help.github.com/send-pull-requests/
|
|
26
|
-
|
|
27
|
-
## Release
|
|
28
|
-
|
|
29
|
-
To release a new version:
|
|
30
|
-
|
|
31
|
-
1. run `bin/refresh`, or `rake regenerate`, to update the regex to current gitmoji set
|
|
32
|
-
- Test `gitmoji/regex/reference_spec.rb` may fail showing new gitmojis
|
|
33
|
-
- These will need to be added to the test, and noted in the CHANGELOG
|
|
34
|
-
2. update the version number in `version.rb`
|
|
35
|
-
3. run `bin/setup && bin/rake` to update `Gemfile.lock`
|
|
36
|
-
4. run `bundle exec rake build:checksum`
|
|
37
|
-
5. move the built gem to project root
|
|
38
|
-
6. run `bin/checksum` to create the missing SHA256 checksum
|
|
39
|
-
7. move the built gem back to `pkg/`
|
|
40
|
-
8. commit the changes
|
|
41
|
-
9. run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org][rubygems].
|
|
42
|
-
|
|
43
|
-
NOTE: You will need to have a public key in `certs/`, and list your cert in the
|
|
44
|
-
`gemspec`, in order to sign the new release.
|
|
45
|
-
See: [RubyGems Security Guide][rubygems-security-guide]
|
|
1
|
+
# Contributing
|
|
46
2
|
|
|
47
|
-
|
|
3
|
+
Bug reports and pull requests are welcome on GitHub, CodeBerg, or [GitLab][🚎src-main].
|
|
4
|
+
This project should be a safe, welcoming space for collaboration, so contributors agree to adhere to
|
|
5
|
+
the [code of conduct][🤝conduct].
|
|
6
|
+
|
|
7
|
+
To submit a patch, please fork the project, create a patch with tests, and send a pull request.
|
|
8
|
+
|
|
9
|
+
Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog].
|
|
10
|
+
|
|
11
|
+
## Help out!
|
|
12
|
+
|
|
13
|
+
Take a look at the `reek` list which is the file called `REEK` and find something to improve.
|
|
14
|
+
|
|
15
|
+
Follow these instructions:
|
|
16
|
+
|
|
17
|
+
1. Fork the repository
|
|
18
|
+
2. Create a feature branch (`git checkout -b my-new-feature`)
|
|
19
|
+
3. Make some fixes.
|
|
20
|
+
4. Commit changes (`git commit -am 'Added some feature'`)
|
|
21
|
+
5. Push to the branch (`git push origin my-new-feature`)
|
|
22
|
+
6. Make sure to add tests for it. This is important, so it doesn't break in a future release.
|
|
23
|
+
7. Create new Pull Request.
|
|
24
|
+
|
|
25
|
+
## Appraisals
|
|
26
|
+
|
|
27
|
+
From time to time the Appraisal2 gemfiles in `gemfiles/` will need to be updated.
|
|
28
|
+
They are created and updated with the commands:
|
|
29
|
+
|
|
30
|
+
```console
|
|
31
|
+
bin/rake appraisal:update
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
When adding an appraisal to CI check the [runner tool cache][🏃♂️runner-tool-cache] to see which runner to use.
|
|
35
|
+
|
|
36
|
+
## The Reek List
|
|
48
37
|
|
|
49
|
-
|
|
38
|
+
Take a look at the `reek` list which is the file called `REEK` and find something to improve.
|
|
50
39
|
|
|
51
|
-
|
|
40
|
+
To refresh the `reek` list:
|
|
52
41
|
|
|
53
|
-
|
|
42
|
+
```console
|
|
43
|
+
bundle exec reek > REEK
|
|
44
|
+
```
|
|
54
45
|
|
|
55
|
-
|
|
46
|
+
## Run Tests
|
|
56
47
|
|
|
57
|
-
|
|
48
|
+
To run all tests
|
|
58
49
|
|
|
59
|
-
|
|
50
|
+
```console
|
|
51
|
+
bundle exec rake test
|
|
52
|
+
```
|
|
60
53
|
|
|
61
|
-
|
|
54
|
+
## Lint It
|
|
55
|
+
|
|
56
|
+
Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
|
|
57
|
+
|
|
58
|
+
```console
|
|
59
|
+
bundle exec rake
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Or just run the linter.
|
|
63
|
+
|
|
64
|
+
```console
|
|
65
|
+
bundle exec rake rubocop_gradual:autocorrect
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
For more detailed information about using RuboCop in this project, please see the [RUBOCOP.md](RUBOCOP.md) guide. This project uses `rubocop_gradual` instead of vanilla RuboCop, which requires specific commands for checking violations.
|
|
69
|
+
|
|
70
|
+
### Important: Do not add inline RuboCop disables
|
|
71
|
+
|
|
72
|
+
Never add `# rubocop:disable ...` / `# rubocop:enable ...` comments to code or specs (except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). Instead:
|
|
73
|
+
|
|
74
|
+
- Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
|
|
75
|
+
- When a violation is temporary and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
|
|
76
|
+
- `bundle exec rake rubocop_gradual:autocorrect` (preferred)
|
|
77
|
+
- `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
|
|
78
|
+
|
|
79
|
+
As a general rule, fix style issues rather than ignoring them. For example, our specs should follow RSpec conventions like using `described_class` for the class under test.
|
|
80
|
+
|
|
81
|
+
## Contributors
|
|
62
82
|
|
|
63
|
-
|
|
83
|
+
Your picture could be here!
|
|
84
|
+
|
|
85
|
+
[![Contributors][🖐contributors-img]][🖐contributors]
|
|
86
|
+
|
|
87
|
+
Made with [contributors-img][🖐contrib-rocks].
|
|
88
|
+
|
|
89
|
+
Also see GitLab Contributors: [https://gitlab.com/galtzo-floss/gitmoji-regex/-/graphs/main][🚎contributors-gl]
|
|
90
|
+
|
|
91
|
+
## For Maintainers
|
|
92
|
+
|
|
93
|
+
### One-time, Per-maintainer, Setup
|
|
94
|
+
|
|
95
|
+
**IMPORTANT**: If you want to sign the build you create,
|
|
96
|
+
your public key for signing gems will need to be picked up by the line in the
|
|
97
|
+
`gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
|
|
98
|
+
All releases to RubyGems.org will be signed.
|
|
99
|
+
See: [RubyGems Security Guide][🔒️rubygems-security-guide]
|
|
100
|
+
|
|
101
|
+
NOTE: To build without signing the gem you must set `SKIP_GEM_SIGNING` to some value in your environment.
|
|
102
|
+
|
|
103
|
+
### To release a new version:
|
|
104
|
+
|
|
105
|
+
1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
|
|
106
|
+
2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
|
|
107
|
+
3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
|
|
108
|
+
4. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
|
|
109
|
+
5. Run `git push` to trigger the final CI pipeline before release, and merge PRs
|
|
110
|
+
- NOTE: Remember to [check the build][🧪build].
|
|
111
|
+
6. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
|
|
112
|
+
7. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
|
|
113
|
+
8. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
|
|
114
|
+
9. Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use same timestamp, and generate same checksums
|
|
115
|
+
- Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
|
|
116
|
+
- If the echo above has no output, then it didn't work.
|
|
117
|
+
- Note: `zsh/datetime` module is needed, if running `zsh`.
|
|
118
|
+
- In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
|
|
119
|
+
10. Run `bundle exec rake build`
|
|
120
|
+
11. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
|
|
121
|
+
to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
|
|
122
|
+
[gem][💎stone_checksums].
|
|
123
|
+
- The script automatically commits but does not push the checksums
|
|
124
|
+
12. Run `bundle exec rake release` which will create a git tag for the version,
|
|
125
|
+
push git commits and tags, and push the `.gem` file to [rubygems.org][💎rubygems]
|
|
126
|
+
|
|
127
|
+
[🚎src-main]: https://gitlab.com/galtzo-floss/gitmoji-regex
|
|
128
|
+
[🧪build]: https://github.com/galtzo-floss/gitmoji-regex/actions
|
|
129
|
+
[🤝conduct]: https://gitlab.com/galtzo-floss/gitmoji-regex/-/blob/main/CODE_OF_CONDUCT.md
|
|
130
|
+
[🖐contrib-rocks]: https://contrib.rocks
|
|
131
|
+
[🖐contributors]: https://github.com/galtzo-floss/gitmoji-regex/graphs/contributors
|
|
132
|
+
[🚎contributors-gl]: https://gitlab.com/galtzo-floss/gitmoji-regex/-/graphs/main
|
|
133
|
+
[🖐contributors-img]: https://contrib.rocks/image?repo=galtzo-floss/gitmoji-regex
|
|
134
|
+
[💎rubygems]: https://rubygems.org
|
|
135
|
+
[🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
|
|
136
|
+
[🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
|
|
137
|
+
[🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
|
|
138
|
+
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
139
|
+
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
140
|
+
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
|
|
141
|
+
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
142
|
+
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
143
|
+
[🏃♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
|