Skip to content

Commit 2e2e837

Browse files
Replace CHANGELOG.markdown with GitHub Releases (#142) (#143)
The markdown changelog was stale and duplicated what GitHub Releases already tracks better. This removes the file, points the gemspec changelog_uri to the releases page, and adds .github/release.yml for auto-categorized release notes on future releases.
1 parent 6cb4b95 commit 2e2e837

3 files changed

Lines changed: 21 additions & 192 deletions

File tree

.github/release.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
changelog:
2+
categories:
3+
- title: Breaking Changes
4+
labels:
5+
- breaking
6+
- title: Added
7+
labels:
8+
- enhancement
9+
- feature
10+
- title: Fixed
11+
labels:
12+
- bug
13+
- fix
14+
- title: Documentation
15+
labels:
16+
- documentation
17+
- title: Other Changes
18+
labels:
19+
- "*"

CHANGELOG.markdown

Lines changed: 0 additions & 190 deletions
This file was deleted.

customerio.gemspec

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
1010
gem.homepage = "https://customer.io"
1111
gem.license = "MIT"
1212

13-
gem.files = Dir["CHANGELOG.markdown", "LICENSE", "README.md", "lib/**/*.rb"]
13+
gem.files = Dir["LICENSE", "README.md", "lib/**/*.rb"]
1414
gem.executables = gem.files.grep(%r{\Abin/}).map { |file| File.basename(file) }
1515
gem.name = "customerio"
1616
gem.require_paths = ["lib"]
@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
1919

2020
gem.metadata = {
2121
"bug_tracker_uri" => "https://github.com/customerio/customerio-ruby/issues",
22-
"changelog_uri" => "https://github.com/customerio/customerio-ruby/blob/main/CHANGELOG.markdown",
22+
"changelog_uri" => "https://github.com/customerio/customerio-ruby/releases",
2323
"homepage_uri" => "https://customer.io",
2424
"rubygems_mfa_required" => "true",
2525
"source_code_uri" => "https://github.com/customerio/customerio-ruby"

0 commit comments

Comments
 (0)