Skip to content

Commit f0bffae

Browse files
committed
doc: Rework the publishing process
1 parent 237e152 commit f0bffae

File tree

2 files changed

+36
-38
lines changed

2 files changed

+36
-38
lines changed

docs/CHANGELOG.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Changelog
22

3+
## [Unreleased]
4+
5+
- Documentation:
6+
- Rework the publishing process
7+
38
## [3.1.0]
49

510
Additions:

docs/pages/publishing.md

+31-38
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,56 @@
11
# Publishing
22

3-
## On Rubygems.org
3+
Change version in `lib/tls_map/version.rb`.
44

5-
```plaintext
6-
$ git tag -a vx.x.x
7-
$ git push --follow-tags
8-
$ gem push tls-map-x.x.x.gem
9-
```
10-
11-
See https://guides.rubygems.org/publishing/.
5+
Be sure all tests pass!
126

13-
On new release don't forget to rebuild the library documentation:
14-
15-
```plaintext
16-
$ bundle exec yard doc
7+
```bash
8+
bundle exec rake test
179
```
1810

19-
And to be sure all tests pass!
11+
Ensure there is no linting offence.
2012

21-
```plaintext
22-
$ bundle exec rake test
13+
```bash
14+
bundle exec rubocop
2315
```
2416

25-
## On BlackArch
17+
Update `data/mapping.marshal` and `data/extended.marshal`:
2618

27-
BA process
19+
```bash
20+
bundle exec ruby -Ilib -rtls_map bin/tls-map update --with-extended
21+
```
2822

29-
On new release don't forget to rebuild the library documentation:
23+
Update `INTEGRITY` of `TLSmap::CLI` and `TLSmap::CLI::Extended` in `lib/tls_map/cli/cli.rb`.
3024

31-
```plaintext
32-
$ bundle exec yard doc
25+
```bash
26+
sha256sum data/*.marshal
3327
```
3428

35-
And to be sure all tests pass!
29+
Update other files:
3630

37-
```plaintext
38-
$ bundle exec rake test
31+
```bash
32+
bundle exec ruby -Ilib -rtls_map bin/tls-map export data/mapping.json json_pretty
33+
bundle exec ruby -Ilib -rtls_map bin/tls-map export data/mapping.min.json json_compact
34+
bundle exec ruby -Ilib -rtls_map bin/tls-map export data/mapping.md markdown
3935
```
4036

41-
## Update data
37+
Update the table in `docs/pages/mapping.md`.
4238

43-
Update `data/mapping.marshal` and `data/extended.marshal`:
39+
Don't forget to rebuild the library documentation:
4440

41+
```bash
42+
bundle exec yard doc
4543
```
46-
$ bundle exec ruby -Ilib -rtls_map bin/tls-map update --with-extended
47-
```
48-
49-
Update `INTEGRITY` of `TLSmap::CLI` and `TLSmap::CLI::Extended` in `lib/tls_map/cli/cli.rb`.
5044

51-
```
52-
$ sha256sum data/*.marshal
53-
```
45+
Push git tag and the gem on Rubygems.
5446

55-
Update other files:
47+
```bash
48+
git tag -a vx.x.x
49+
git push --follow-tags
5650

57-
```
58-
$ bundle exec ruby -Ilib -rtls_map bin/tls-map export data/mapping.json json_pretty
59-
$ bundle exec ruby -Ilib -rtls_map bin/tls-map export data/mapping.min.json json_compact
60-
$ bundle exec ruby -Ilib -rtls_map bin/tls-map export data/mapping.md markdown
51+
bundle exec rake build
52+
gem push tls-map-x.x.x.gem
6153
```
6254

63-
Update the table in `docs/pages/mapping.md`.
55+
See https://guides.rubygems.org/publishing/.
56+

0 commit comments

Comments
 (0)