|
1 | 1 | # Publishing
|
2 | 2 |
|
3 |
| -## On Rubygems.org |
| 3 | +Change version in `lib/tls_map/version.rb`. |
4 | 4 |
|
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! |
12 | 6 |
|
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 |
17 | 9 | ```
|
18 | 10 |
|
19 |
| -And to be sure all tests pass! |
| 11 | +Ensure there is no linting offence. |
20 | 12 |
|
21 |
| -```plaintext |
22 |
| -$ bundle exec rake test |
| 13 | +```bash |
| 14 | +bundle exec rubocop |
23 | 15 | ```
|
24 | 16 |
|
25 |
| -## On BlackArch |
| 17 | +Update `data/mapping.marshal` and `data/extended.marshal`: |
26 | 18 |
|
27 |
| -BA process |
| 19 | +```bash |
| 20 | +bundle exec ruby -Ilib -rtls_map bin/tls-map update --with-extended |
| 21 | +``` |
28 | 22 |
|
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`. |
30 | 24 |
|
31 |
| -```plaintext |
32 |
| -$ bundle exec yard doc |
| 25 | +```bash |
| 26 | +sha256sum data/*.marshal |
33 | 27 | ```
|
34 | 28 |
|
35 |
| -And to be sure all tests pass! |
| 29 | +Update other files: |
36 | 30 |
|
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 |
39 | 35 | ```
|
40 | 36 |
|
41 |
| -## Update data |
| 37 | +Update the table in `docs/pages/mapping.md`. |
42 | 38 |
|
43 |
| -Update `data/mapping.marshal` and `data/extended.marshal`: |
| 39 | +Don't forget to rebuild the library documentation: |
44 | 40 |
|
| 41 | +```bash |
| 42 | +bundle exec yard doc |
45 | 43 | ```
|
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`. |
50 | 44 |
|
51 |
| -``` |
52 |
| -$ sha256sum data/*.marshal |
53 |
| -``` |
| 45 | +Push git tag and the gem on Rubygems. |
54 | 46 |
|
55 |
| -Update other files: |
| 47 | +```bash |
| 48 | +git tag -a vx.x.x |
| 49 | +git push --follow-tags |
56 | 50 |
|
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 |
61 | 53 | ```
|
62 | 54 |
|
63 |
| -Update the table in `docs/pages/mapping.md`. |
| 55 | +See https://guides.rubygems.org/publishing/. |
| 56 | + |
0 commit comments