gitlab-markup 2.1.0 → 2.2.1

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: 790926e8c03a6d1e4a383c1bedd246625ca1e9cfe75c23d2fcf8ac88e08c3f93
4
- data.tar.gz: b0bec8c4d722247d81bb6253634633f7fa82cf9774092f1a1069e86b5ab75433
3
+ metadata.gz: 07fdbceaf3ac4c23eaf4e3b2ba3039d7128c442da418f70f5e46e37422ca692a
4
+ data.tar.gz: fc47174cd8dc2d3019acb9d9f1399b841d91b97818cb6040866a31dc8c5fbcf2
5
5
  SHA512:
6
- metadata.gz: 7208b88b8a5087edf00ce36318d870219b728202491a87e5d03692c0d262b42a7d1114b8999d04ba671e9c08349d20088ef4c7b13cdb6888639f2eb51630738a
7
- data.tar.gz: 98152d6bcb1a268f69a1b3c079c5ca21481d5305afd404a58bfd0d7810b7d21a48a6be8c5c70c68807c0f98e55a3a68d0a0351d59f446783012782221f3e2bfc
6
+ metadata.gz: '0092c11fe007ff5dd6a9b0d321a54d918499fab4da110b0e65240f5fe6a96095c7c1e791737f1a9bc0fab069102f893be798f1cf343b6ab9f02aee8f44f7151d'
7
+ data.tar.gz: 6ee1e0614dacffd66279f9f5d2f625c5f4afd94b0d0fa1861e015d3795d0e52d5e5d5f2ab2ee274d3dbc57141e873f1733bb2fe3d3b606d1673bbf41757531b3
data/.gitlab-ci.yml CHANGED
@@ -2,6 +2,10 @@ include:
2
2
  - template: SAST.gitlab-ci.yml # https://gitlab.com/gitlab-org/gitlab-foss/blob/master/lib/gitlab/ci/templates/Security/SAST.gitlab-ci.yml
3
3
  - template: Security/Dependency-Scanning.gitlab-ci.yml # https://docs.gitlab.com/ee/user/application_security/dependency_scanning/
4
4
  - template: Security/Secret-Detection.gitlab-ci.yml # https://docs.gitlab.com/ee/user/application_security/secret_detection/
5
+ - component: gitlab.com/gitlab-org/components/gem-release/gem-release@~latest
6
+ inputs:
7
+ # The version is defined in lib/github-markup.rb, not the default lib/**/version.rb.
8
+ file_pattern_to_trigger_release: "lib/github-markup.rb"
5
9
 
6
10
  variables:
7
11
  LANG: "C.UTF-8"
@@ -48,7 +52,7 @@ ruby-docutils-spec:
48
52
  extends: .specs
49
53
  parallel:
50
54
  matrix:
51
- - RUBY_VERSION: ['3.0', '3.1', '3.2', '3.3', '3.4']
55
+ - RUBY_VERSION: ['3.2', '3.3', '3.4', '4.0']
52
56
  DOCUTILS_VERSION: ['0.21.2']
53
57
 
54
58
  # Dependency Scanning
data/CONTRIBUTING.md CHANGED
@@ -72,16 +72,33 @@ If nothing complains, congratulations!
72
72
 
73
73
  ## Releasing a new version
74
74
 
75
+ Releases are automated by the
76
+ [`gem-release`](https://gitlab.com/gitlab-org/components/gem-release) CI/CD
77
+ component configured in `.gitlab-ci.yml`.
78
+
75
79
  If you are the current maintainer of this gem:
76
80
 
77
- 0. Bump the version number in `lib/github-markup.rb`, adhering to [Semantic Versioning](http://semver.org/)
78
- 0. Update `HISTORY.md`
79
- 0. Test the latest version on GitHub
80
- 0. Build the new version with `rake build`
81
- 0. Copy `pkg/gitlab-markup*.gem` to `vendor/cache` in your local checkout of GitHub
82
- 0. Update the version for `gitlab-markup` in the `Gemfile`
83
- 0. Run `bundle update --local gitlab-markup`
84
- 0. Run any relevant tests and test it manually from the browser.
85
- 0. Push the new gem release with `rake release`. If you don't have permission to release to rubygems.org, contact one of the existing owners (`gem owners gitlab-markup`) and ask them to add you.
81
+ 1. Open a merge request that bumps `VERSION` in `lib/github-markup.rb`, adhering
82
+ to [Semantic Versioning](https://semver.org/). Update `HISTORY.md` in the same
83
+ merge request, and add a `Changelog:` trailer to the commit so the change
84
+ appears in the generated release notes.
85
+ 2. Once the merge request is merged to `master`, the pipeline detects the change
86
+ to `lib/github-markup.rb` and runs the release jobs automatically: it builds
87
+ the gem, creates a GitLab release, and publishes the gem to RubyGems.
88
+
89
+ Notes:
90
+
91
+ - Only edit `lib/github-markup.rb` to bump `VERSION`. Any change to it on
92
+ `master` triggers the release jobs, so a non-version edit would start a release
93
+ for a version that is already published; the `gem push` then fails, which is
94
+ harmless (nothing is re-published) but produces a red pipeline.
95
+ - The release is tagged with the bare version (for example `2.3.0`). Tags created
96
+ before this automation was adopted used a `v` prefix (`v2.2.0`); older tags are
97
+ left as-is.
98
+ - Release notes are generated from `Changelog:` commit trailers via the GitLab
99
+ changelog API. Commits without that trailer produce empty notes.
100
+ - Publishing requires the `GEM_HOST_API_KEY` CI/CD variable (a RubyGems API key
101
+ with push access), restricted to protected branches. If you need push access to
102
+ RubyGems, contact one of the existing owners (`gem owners gitlab-markup`).
86
103
 
87
104
  [1]: https://gitlab.com/gitlab-org/gitlab-markup/merge_requests
data/HISTORY.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # History
2
2
 
3
+ ## 2.2.1 (2026-10-15)
4
+
5
+ * [Add automated gem release pipeline using the gem-release CI component](https://gitlab.com/gitlab-org/ruby/gems/gitlab-markup/-/merge_requests/63)
6
+
7
+ ## 2.2.0 (2026-10-15)
8
+
9
+ * [Allow RDoc 8, require Ruby 3.2+](https://gitlab.com/gitlab-org/gitlab-markup/-/merge_requests/62)
10
+
3
11
  ## 2.1.0 (2026-05-26)
4
12
 
5
13
  * [Remove markdown, asciidoc, litcoffee, and pod rendering; make markup gem dependencies explicit](https://gitlab.com/gitlab-org/gitlab-markup/-/merge_requests/55)
@@ -15,6 +15,8 @@ Gem::Specification.new do |s|
15
15
  s.test_files = s.files.grep(%r{^(test|spec|features)/})
16
16
  s.require_paths = %w[lib]
17
17
 
18
+ s.required_ruby_version = '>= 3.2'
19
+
18
20
  s.metadata = {
19
21
  'bug_tracker_uri' => 'https://gitlab.com/gitlab-org/gitlab-markup/issues',
20
22
  'changelog_uri' => 'https://gitlab.com/gitlab-org/gitlab-markup/blob/master/HISTORY.md',
@@ -28,11 +30,11 @@ Gem::Specification.new do |s|
28
30
  s.add_development_dependency 'mutex_m', '~> 0.3.0'
29
31
  s.add_development_dependency 'nokogiri', '~> 1.13.8'
30
32
  s.add_development_dependency 'nokogiri-diff', '~> 0.2.0'
31
- s.add_development_dependency 'rdoc', '~> 6.12'
33
+ s.add_development_dependency 'rdoc', '>= 6.13', '< 9'
32
34
  s.add_development_dependency 'sanitize', '~> 6.0.0'
33
35
 
34
36
  s.add_dependency 'RedCloth', '~> 4.3'
35
- s.add_dependency 'rdoc', '~> 6.13'
37
+ s.add_dependency 'rdoc', '>= 6.13', '< 9'
36
38
  s.add_dependency 'org-ruby', '~> 0.9'
37
39
  s.add_dependency 'creole', '~> 0.5.0'
38
40
  s.add_dependency 'wikicloth', '=0.8.1'
@@ -10,11 +10,13 @@ module GitHub
10
10
  end
11
11
 
12
12
  def render(content)
13
- if ::RDoc::VERSION.to_i >= 4
14
- h = ::RDoc::Markup::ToHtml.new(::RDoc::Options.new)
15
- else
16
- h = ::RDoc::Markup::ToHtml.new
17
- end
13
+ # RDoc 8 changed ToHtml.new to take keyword arguments instead of
14
+ # an RDoc::Options instance.
15
+ h = if ::RDoc::VERSION.to_i >= 8
16
+ ::RDoc::Markup::ToHtml.new
17
+ else
18
+ ::RDoc::Markup::ToHtml.new(::RDoc::Options.new)
19
+ end
18
20
  h.convert(content)
19
21
  end
20
22
 
data/lib/github-markup.rb CHANGED
@@ -1,6 +1,6 @@
1
1
  module GitHub
2
2
  module Markup
3
- VERSION = '2.1.0'
3
+ VERSION = '2.2.1'
4
4
  Version = VERSION
5
5
  end
6
6
  end
metadata CHANGED
@@ -1,14 +1,15 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gitlab-markup
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.1.0
4
+ version: 2.2.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Chris Wanstrath
8
8
  - GitLab Engineering Team
9
+ autorequire:
9
10
  bindir: bin
10
11
  cert_chain: []
11
- date: 1980-01-02 00:00:00.000000000 Z
12
+ date: 2026-10-16 00:00:00.000000000 Z
12
13
  dependencies:
13
14
  - !ruby/object:Gem::Dependency
14
15
  name: activesupport
@@ -112,16 +113,22 @@ dependencies:
112
113
  name: rdoc
113
114
  requirement: !ruby/object:Gem::Requirement
114
115
  requirements:
115
- - - "~>"
116
+ - - ">="
117
+ - !ruby/object:Gem::Version
118
+ version: '6.13'
119
+ - - "<"
116
120
  - !ruby/object:Gem::Version
117
- version: '6.12'
121
+ version: '9'
118
122
  type: :development
119
123
  prerelease: false
120
124
  version_requirements: !ruby/object:Gem::Requirement
121
125
  requirements:
122
- - - "~>"
126
+ - - ">="
127
+ - !ruby/object:Gem::Version
128
+ version: '6.13'
129
+ - - "<"
123
130
  - !ruby/object:Gem::Version
124
- version: '6.12'
131
+ version: '9'
125
132
  - !ruby/object:Gem::Dependency
126
133
  name: sanitize
127
134
  requirement: !ruby/object:Gem::Requirement
@@ -154,16 +161,22 @@ dependencies:
154
161
  name: rdoc
155
162
  requirement: !ruby/object:Gem::Requirement
156
163
  requirements:
157
- - - "~>"
164
+ - - ">="
158
165
  - !ruby/object:Gem::Version
159
166
  version: '6.13'
167
+ - - "<"
168
+ - !ruby/object:Gem::Version
169
+ version: '9'
160
170
  type: :runtime
161
171
  prerelease: false
162
172
  version_requirements: !ruby/object:Gem::Requirement
163
173
  requirements:
164
- - - "~>"
174
+ - - ">="
165
175
  - !ruby/object:Gem::Version
166
176
  version: '6.13'
177
+ - - "<"
178
+ - !ruby/object:Gem::Version
179
+ version: '9'
167
180
  - !ruby/object:Gem::Dependency
168
181
  name: org-ruby
169
182
  requirement: !ruby/object:Gem::Requirement
@@ -267,6 +280,7 @@ metadata:
267
280
  bug_tracker_uri: https://gitlab.com/gitlab-org/gitlab-markup/issues
268
281
  changelog_uri: https://gitlab.com/gitlab-org/gitlab-markup/blob/master/HISTORY.md
269
282
  source_code_uri: https://gitlab.com/gitlab-org/gitlab-markup
283
+ post_install_message:
270
284
  rdoc_options: []
271
285
  require_paths:
272
286
  - lib
@@ -274,14 +288,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
274
288
  requirements:
275
289
  - - ">="
276
290
  - !ruby/object:Gem::Version
277
- version: '0'
291
+ version: '3.2'
278
292
  required_rubygems_version: !ruby/object:Gem::Requirement
279
293
  requirements:
280
294
  - - ">="
281
295
  - !ruby/object:Gem::Version
282
296
  version: '0'
283
297
  requirements: []
284
- rubygems_version: 3.7.2
298
+ rubygems_version: 3.5.22
299
+ signing_key:
285
300
  specification_version: 4
286
301
  summary: Fork from github-markup GitLab uses to render non markdown content
287
302
  test_files: