From 55a3b5e0fa0818751bb2340f9d8a3a9b638aa4b2 Mon Sep 17 00:00:00 2001 From: Kenta Okamoto <85665+chocoby@users.noreply.github.com> Date: Sun, 2 Aug 2026 15:57:55 +0900 Subject: [PATCH 1/6] ci: support bracketed version headings in release notes extraction --- .github/workflows/release.yml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index d7cf84c..1cb999d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -138,7 +138,14 @@ jobs: run: | version="${TAG#v}" awk -v ver="$version" ' - /^## / { found = ($2 == ver); next } + /^\[[^]]+\]: / { found = 0; next } + /^## / { + h = $0 + sub(/^## +\[?/, "", h) + sub(/\].*$|[ (].*$/, "", h) + found = (h == ver) + next + } found ' CHANGELOG.md > release-notes.md if ! grep -q '[^[:space:]]' release-notes.md; then From 742492d682e17cfa19af0e06322837bf7ebdc5ae Mon Sep 17 00:00:00 2001 From: Kenta Okamoto <85665+chocoby@users.noreply.github.com> Date: Sun, 2 Aug 2026 16:01:44 +0900 Subject: [PATCH 2/6] docs: convert changelog headings and entry notation --- CHANGELOG.md | 120 +++++++++++++++++++++++++-------------------------- 1 file changed, 60 insertions(+), 60 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b7b8d60..b267943 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,68 +1,68 @@ -## Unreleased +## [Unreleased] ### Features -* Rails 8.1 をサポートに追加 (PR [#78](https://github.com/chocoby/jp_prefecture/pull/78)/[@chocoby](https://github.com/chocoby)) -* Ruby 4.0 をサポートに追加 (PR [#80](https://github.com/chocoby/jp_prefecture/pull/80)/[@chocoby](https://github.com/chocoby)) +* Rails 8.1 をサポートに追加 ([#78](https://github.com/chocoby/jp_prefecture/pull/78), [@chocoby](https://github.com/chocoby)) +* Ruby 4.0 をサポートに追加 ([#80](https://github.com/chocoby/jp_prefecture/pull/80), [@chocoby](https://github.com/chocoby)) -## 1.1.2 (2025-02-24) +## [1.1.2] - 2025-02-24 ### Features -* Ruby 3.2 をサポートに追加 (PR [#61](https://github.com/chocoby/jp_prefecture/pull/61)/[@chocoby](https://github.com/chocoby)) -* Rails 7.1 をサポートに追加 (PR [#63](https://github.com/chocoby/jp_prefecture/pull/63)/[@chocoby](https://github.com/chocoby)) -* Ruby 3.3 をサポートに追加 (PR [#64](https://github.com/chocoby/jp_prefecture/pull/64)/[@chocoby](https://github.com/chocoby)) -* Rails 7.2 をサポートに追加 (PR [#65](https://github.com/chocoby/jp_prefecture/pull/65)/[@y-yagi](https://github.com/y-yagi)) -* Ruby 3.4 をサポートに追加 (PR [#67](https://github.com/chocoby/jp_prefecture/pull/67)/[@chocoby](https://github.com/chocoby)) -* Rails 8.0 をサポートに追加 (PR [#68](https://github.com/chocoby/jp_prefecture/pull/68)/[@chocoby](https://github.com/chocoby)) -* 郵便番号データの更新 (PR [#74](https://github.com/chocoby/jp_prefecture/pull/74)/[@chocoby](https://github.com/chocoby)) +* Ruby 3.2 をサポートに追加 ([#61](https://github.com/chocoby/jp_prefecture/pull/61), [@chocoby](https://github.com/chocoby)) +* Rails 7.1 をサポートに追加 ([#63](https://github.com/chocoby/jp_prefecture/pull/63), [@chocoby](https://github.com/chocoby)) +* Ruby 3.3 をサポートに追加 ([#64](https://github.com/chocoby/jp_prefecture/pull/64), [@chocoby](https://github.com/chocoby)) +* Rails 7.2 をサポートに追加 ([#65](https://github.com/chocoby/jp_prefecture/pull/65), [@y-yagi](https://github.com/y-yagi)) +* Ruby 3.4 をサポートに追加 ([#67](https://github.com/chocoby/jp_prefecture/pull/67), [@chocoby](https://github.com/chocoby)) +* Rails 8.0 をサポートに追加 ([#68](https://github.com/chocoby/jp_prefecture/pull/68), [@chocoby](https://github.com/chocoby)) +* 郵便番号データの更新 ([#74](https://github.com/chocoby/jp_prefecture/pull/74), [@chocoby](https://github.com/chocoby)) ### Bug fix -* `bundle exec rake create_zip_code_data` 実行時のランタイムエラーを修正/郵便番号データ更新 (PR [#70](https://github.com/chocoby/jp_prefecture/pull/70)/[@ydah](https://github.com/ydah)) +* `bundle exec rake create_zip_code_data` 実行時のランタイムエラーを修正/郵便番号データ更新 ([#70](https://github.com/chocoby/jp_prefecture/pull/70), [@ydah](https://github.com/ydah)) ### Documentation -* 都道府県コードの参照先を `JIS X 0401` に修正 (PR [#71](https://github.com/chocoby/jp_prefecture/pull/71)/[@ydah](https://github.com/ydah)) +* 都道府県コードの参照先を `JIS X 0401` に修正 ([#71](https://github.com/chocoby/jp_prefecture/pull/71), [@ydah](https://github.com/ydah)) ### Misc -* RuboCop の警告を修正 (PR [#69](https://github.com/chocoby/jp_prefecture/pull/69)/[@ydah](https://github.com/ydah)) -* appraisal gem の依存を削除 (PR [#73](https://github.com/chocoby/jp_prefecture/pull/73)/[@chocoby](https://github.com/chocoby)) -* concurrent-ruby gem v1.3.5 で `logger` の依存が削除されたことへの対応 (PR [#72](https://github.com/chocoby/jp_prefecture/pull/72)/[@chocoby](https://github.com/chocoby)) +* RuboCop の警告を修正 ([#69](https://github.com/chocoby/jp_prefecture/pull/69), [@ydah](https://github.com/ydah)) +* appraisal gem の依存を削除 ([#73](https://github.com/chocoby/jp_prefecture/pull/73), [@chocoby](https://github.com/chocoby)) +* concurrent-ruby gem v1.3.5 で `logger` の依存が削除されたことへの対応 ([#72](https://github.com/chocoby/jp_prefecture/pull/72), [@chocoby](https://github.com/chocoby)) -## 1.1.1 (2022-03-25) +## [1.1.1] - 2022-03-25 ### Bug fix -* マッピングに項目が存在しない場合にエラーが発生する問題を修正 (PR [#59](https://github.com/chocoby/jp_prefecture/pull/59)/[@chocoby](https://github.com/chocoby)) +* マッピングに項目が存在しない場合にエラーが発生する問題を修正 ([#59](https://github.com/chocoby/jp_prefecture/pull/59), [@chocoby](https://github.com/chocoby)) -## 1.1.0 (2022-03-17) +## [1.1.0] - 2022-03-17 ### Features -* 都道府県情報にローマ字表記を追加 (PR [#57](https://github.com/chocoby/jp_prefecture/pull/57)/[@sondh5](https://github.com/sondh5)) -* Ruby 3.1 をサポートに追加 (PR [#54](https://github.com/chocoby/jp_prefecture/pull/54)/[@chocoby](https://github.com/chocoby)) -* Rails 7.0 をサポート (PR [#55](https://github.com/chocoby/jp_prefecture/pull/55)/[@chocoby](https://github.com/chocoby)) +* 都道府県情報にローマ字表記を追加 ([#57](https://github.com/chocoby/jp_prefecture/pull/57), [@sondh5](https://github.com/sondh5)) +* Ruby 3.1 をサポートに追加 ([#54](https://github.com/chocoby/jp_prefecture/pull/54), [@chocoby](https://github.com/chocoby)) +* Rails 7.0 をサポート ([#55](https://github.com/chocoby/jp_prefecture/pull/55), [@chocoby](https://github.com/chocoby)) -## 1.0.0 (2021-02-24) +## [1.0.0] - 2021-02-24 ### Misc -* 毎週月曜日の 09:00 (JST) にテストを実行する (PR [#52](https://github.com/chocoby/jp_prefecture/pull/52)/[@chocoby](https://github.com/chocoby)) +* 毎週月曜日の 09:00 (JST) にテストを実行する ([#52](https://github.com/chocoby/jp_prefecture/pull/52), [@chocoby](https://github.com/chocoby)) -## 1.0.0.rc1 (2021-02-10) +## [1.0.0.rc1] - 2021-02-10 ### Breaking changes -* Ruby 1.9.3 - 2.3/Rails 3.2 - 4.2 のサポートを終了 (PR [#39](https://github.com/chocoby/jp_prefecture/pull/39)/[@chocoby](https://github.com/chocoby)) +* Ruby 1.9.3 - 2.3/Rails 3.2 - 4.2 のサポートを終了 ([#39](https://github.com/chocoby/jp_prefecture/pull/39), [@chocoby](https://github.com/chocoby)) 古い Ruby/Rails のサポートを終了しました。今後も大きな不具合が見つかった場合、可能な限りは対応する予定です。 サポートするバージョンの範囲は Ruby/Rails のメンテナンスポリシーに則るのがシンプルですが、この Gem では厳しくする必要はないと考えています。 Ruby/Rails のメンテナンスポリシーで決められているバージョンは最低限サポートし、実装やテストのメンテナンスが困難になったバージョンからサポートを終了する方針で検討しています。ご意見があればください。 -* 文字列による検索は項目を指定して検索する (Issue [#24](https://github.com/chocoby/jp_prefecture/issues/24), [#27](https://github.com/chocoby/jp_prefecture/issues/27)/PR [#43](https://github.com/chocoby/jp_prefecture/pull/43)/[@chocoby](https://github.com/chocoby)) +* 文字列による検索は項目を指定して検索する ([#43](https://github.com/chocoby/jp_prefecture/pull/43), [#24](https://github.com/chocoby/jp_prefecture/issues/24), [#27](https://github.com/chocoby/jp_prefecture/issues/27), [@chocoby](https://github.com/chocoby)) `JpPrefecture::Prefecture.find(name: '東')` を実行すると、青森県が取得されていた問題への対応です。これはマッピングのすべての項目を検索していたためです。 対応として、`name` を指定した場合は漢字表記、`name_e` は英語表記など、指定した項目のみを検索するように変更しました。詳しい使い方は README を参照してください。 @@ -70,92 +70,92 @@ ### Features -* Ruby 3.0 をサポートに追加 (PR [#42](https://github.com/chocoby/jp_prefecture/pull/42)/[@chocoby](https://github.com/chocoby)) -* 郵便番号データを更新 (PR [#46](https://github.com/chocoby/jp_prefecture/pull/46)/[@chocoby](https://github.com/chocoby)) -* `JpPrefecture::Prefecture` クラスに都道府県コードから都道府県インスタンスを作成する `build_by_code` メソッドを追加 (PR [#44](https://github.com/chocoby/jp_prefecture/pull/44)/[@chocoby](https://github.com/chocoby)) +* Ruby 3.0 をサポートに追加 ([#42](https://github.com/chocoby/jp_prefecture/pull/42), [@chocoby](https://github.com/chocoby)) +* 郵便番号データを更新 ([#46](https://github.com/chocoby/jp_prefecture/pull/46), [@chocoby](https://github.com/chocoby)) +* `JpPrefecture::Prefecture` クラスに都道府県コードから都道府県インスタンスを作成する `build_by_code` メソッドを追加 ([#44](https://github.com/chocoby/jp_prefecture/pull/44), [@chocoby](https://github.com/chocoby)) 都道府県コードを指定すると、それに対応した都道府県の `JpPrefecture::Prefecture` インスタンスを取得するメソッドを追加しました。 `JpPrefecture::Prefecture.build` メソッドは参照している処理がなくなったため、削除しました。 ### Documentation -* CONTRIBUTING.md を追加 (PR [#41](https://github.com/chocoby/jp_prefecture/pull/41)/[@chocoby](https://github.com/chocoby)) +* CONTRIBUTING.md を追加 ([#41](https://github.com/chocoby/jp_prefecture/pull/41), [@chocoby](https://github.com/chocoby)) ### Misc -* RuboCop を導入 (PR [#40](https://github.com/chocoby/jp_prefecture/pull/40)/[@chocoby](https://github.com/chocoby)) -* Gem に含めるファイルを最低限のものにする (PR [#48](https://github.com/chocoby/jp_prefecture/pull/48)/[@chocoby](https://github.com/chocoby)) +* RuboCop を導入 ([#40](https://github.com/chocoby/jp_prefecture/pull/40), [@chocoby](https://github.com/chocoby)) +* Gem に含めるファイルを最低限のものにする ([#48](https://github.com/chocoby/jp_prefecture/pull/48), [@chocoby](https://github.com/chocoby)) -## 0.11.0 (2020-12-18) +## [0.11.0] - 2020-12-18 -* Rails 6.1 をサポート (PR [#37](https://github.com/chocoby/jp_prefecture/pull/37)/[@chocoby](https://github.com/chocoby)) -* GitHub Actions でビルドを実行するようにした (PR [#34](https://github.com/chocoby/jp_prefecture/pull/34)/[@chocoby](https://github.com/chocoby)) +* Rails 6.1 をサポート ([#37](https://github.com/chocoby/jp_prefecture/pull/37), [@chocoby](https://github.com/chocoby)) +* GitHub Actions でビルドを実行するようにした ([#34](https://github.com/chocoby/jp_prefecture/pull/34), [@chocoby](https://github.com/chocoby)) -## 0.10.0 (2019-08-19) +## [0.10.0] - 2019-08-19 -* Rails 6.0 をサポート (PR [#33](https://github.com/chocoby/jp_prefecture/pull/33)/[@chocoby](https://github.com/chocoby)) +* Rails 6.0 をサポート ([#33](https://github.com/chocoby/jp_prefecture/pull/33), [@chocoby](https://github.com/chocoby)) -## 0.9.0 (2017-01-15) +## [0.9.0] - 2017-01-15 -* Add English Readme (Issue [#21](https://github.com/chocoby/jp_prefecture/issues/21)/PR [#22](https://github.com/chocoby/jp_prefecture/pull/22)/[@PeterTeng](https://github.com/PeterTeng)) -* 都道府県情報に種類を追加 (PR [#23](https://github.com/chocoby/jp_prefecture/pull/23)/[@gazayas](https://github.com/gazayas)) +* Add English Readme ([#22](https://github.com/chocoby/jp_prefecture/pull/22), [#21](https://github.com/chocoby/jp_prefecture/issues/21), [@PeterTeng](https://github.com/PeterTeng)) +* 都道府県情報に種類を追加 ([#23](https://github.com/chocoby/jp_prefecture/pull/23), [@gazayas](https://github.com/gazayas)) -## 0.8.1 (2016-03-30) +## [0.8.1] - 2016-03-30 -* `JpPrefecture::Prefecture.find(name: name)` に `nil` や空文字を渡した時に `nil` を返す (Issue [#18](https://github.com/chocoby/jp_prefecture/issues/18)/PR [#19](https://github.com/chocoby/jp_prefecture/pull/19)/[@k-motoyan](https://github.com/k-motoyan)) +* `JpPrefecture::Prefecture.find(name: name)` に `nil` や空文字を渡した時に `nil` を返す ([#19](https://github.com/chocoby/jp_prefecture/pull/19), [#18](https://github.com/chocoby/jp_prefecture/issues/18), [@k-motoyan](https://github.com/k-motoyan)) -## 0.8.0 (2014-09-07) +## [0.8.0] - 2014-09-07 -* 都道府県情報に八地方区分情報を追加 (PR [#14](https://github.com/chocoby/jp_prefecture/pull/14)/[@kkosuge](https://github.com/kkosuge)) +* 都道府県情報に八地方区分情報を追加 ([#14](https://github.com/chocoby/jp_prefecture/pull/14), [@kkosuge](https://github.com/kkosuge)) -## 0.7.0 (2014-06-18) +## [0.7.0] - 2014-06-18 -* 都道府県名にひらがな、カタカナを追加 (PR [#12](https://github.com/chocoby/jp_prefecture/pull/12)/[@yukihr](https://github.com/yukihr)) +* 都道府県名にひらがな、カタカナを追加 ([#12](https://github.com/chocoby/jp_prefecture/pull/12), [@yukihr](https://github.com/yukihr)) -## 0.6.0 (2014-03-10) +## [0.6.0] - 2014-03-10 -* 都道府県名を前方一致で検索できるようにした (PR [#11](https://github.com/chocoby/jp_prefecture/pull/11)/[@yuuna](https://github.com/yuuna)) +* 都道府県名を前方一致で検索できるようにした ([#11](https://github.com/chocoby/jp_prefecture/pull/11), [@yuuna](https://github.com/yuuna)) * 都道府県名の検索ロジックを高速化 -## 0.5.0 (2013-11-30) +## [0.5.0] - 2013-11-30 -* 郵便番号から都道府県を検索する機能の追加 (PR [#9](https://github.com/chocoby/jp_prefecture/pull/9)/[@fruwe](https://github.com/fruwe)) +* 郵便番号から都道府県を検索する機能の追加 ([#9](https://github.com/chocoby/jp_prefecture/pull/9), [@fruwe](https://github.com/fruwe)) -## 0.4.0 (2013-07-08) +## [0.4.0] - 2013-07-08 -* 都道府県のマッピングを変更する機能の追加 (PR [#8](https://github.com/chocoby/jp_prefecture/pull/8)/[@mizoR](https://github.com/mizoR)) +* 都道府県のマッピングを変更する機能の追加 ([#8](https://github.com/chocoby/jp_prefecture/pull/8), [@mizoR](https://github.com/mizoR)) -## 0.3.2 (2013-06-12) +## [0.3.2] - 2013-06-12 * 文字列を downcase してから都道府県の検索を行うようにした -## 0.3.1 (2013-06-11) +## [0.3.1] - 2013-06-11 * name で渡した文字列が変更されるバグを修正 -## 0.3.0 (2013-06-11) +## [0.3.0] - 2013-06-11 * 都道府県名(英語表記含む)から都道府県を検索できるようにした * 都道府県名からの検索と同様の方法で、都道府県コードを検索できるようにした * String 型の都道府県コードに対応 -## 0.2.0 (2013-06-09) +## [0.2.0] - 2013-06-09 * 英語表記を追加 * Ruby 1.8.7 のサポートを終了 -## 0.1.1 (2013-03-01) +## [0.1.1] - 2013-03-01 * モデルで使用する時に、生成するメソッド名を指定できるようにした * Configuration モデル/Model モジュールを廃止 * extend による使用を廃止 * Travis CI によるテストを行うようにした -## 0.1.0 (2013-02-17) +## [0.1.0] - 2013-02-17 * モデルで使用する時に、対象のカラム名を指定するようにした -## 0.0.1 (2013-02-14) +## [0.0.1] - 2013-02-14 * 都道府県の変換 * 簡単な Rails サポート From 7f3e8e4817d11fdea963e14ee1d2f8643fdd7dca Mon Sep 17 00:00:00 2001 From: Kenta Okamoto <85665+chocoby@users.noreply.github.com> Date: Sun, 2 Aug 2026 16:08:42 +0900 Subject: [PATCH 3/6] docs: reclassify changelog sections into Keep a Changelog categories --- CHANGELOG.md | 56 +++++++++++++++++++++++----------------------------- 1 file changed, 25 insertions(+), 31 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b267943..29dae7b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,13 +1,13 @@ ## [Unreleased] -### Features +### Added * Rails 8.1 をサポートに追加 ([#78](https://github.com/chocoby/jp_prefecture/pull/78), [@chocoby](https://github.com/chocoby)) * Ruby 4.0 をサポートに追加 ([#80](https://github.com/chocoby/jp_prefecture/pull/80), [@chocoby](https://github.com/chocoby)) ## [1.1.2] - 2025-02-24 -### Features +### Added * Ruby 3.2 をサポートに追加 ([#61](https://github.com/chocoby/jp_prefecture/pull/61), [@chocoby](https://github.com/chocoby)) * Rails 7.1 をサポートに追加 ([#63](https://github.com/chocoby/jp_prefecture/pull/63), [@chocoby](https://github.com/chocoby)) @@ -15,31 +15,28 @@ * Rails 7.2 をサポートに追加 ([#65](https://github.com/chocoby/jp_prefecture/pull/65), [@y-yagi](https://github.com/y-yagi)) * Ruby 3.4 をサポートに追加 ([#67](https://github.com/chocoby/jp_prefecture/pull/67), [@chocoby](https://github.com/chocoby)) * Rails 8.0 をサポートに追加 ([#68](https://github.com/chocoby/jp_prefecture/pull/68), [@chocoby](https://github.com/chocoby)) -* 郵便番号データの更新 ([#74](https://github.com/chocoby/jp_prefecture/pull/74), [@chocoby](https://github.com/chocoby)) - -### Bug fix -* `bundle exec rake create_zip_code_data` 実行時のランタイムエラーを修正/郵便番号データ更新 ([#70](https://github.com/chocoby/jp_prefecture/pull/70), [@ydah](https://github.com/ydah)) - -### Documentation +### Changed +* 郵便番号データの更新 ([#74](https://github.com/chocoby/jp_prefecture/pull/74), [@chocoby](https://github.com/chocoby)) * 都道府県コードの参照先を `JIS X 0401` に修正 ([#71](https://github.com/chocoby/jp_prefecture/pull/71), [@ydah](https://github.com/ydah)) - -### Misc - * RuboCop の警告を修正 ([#69](https://github.com/chocoby/jp_prefecture/pull/69), [@ydah](https://github.com/ydah)) * appraisal gem の依存を削除 ([#73](https://github.com/chocoby/jp_prefecture/pull/73), [@chocoby](https://github.com/chocoby)) + +### Fixed + +* `bundle exec rake create_zip_code_data` 実行時のランタイムエラーを修正/郵便番号データ更新 ([#70](https://github.com/chocoby/jp_prefecture/pull/70), [@ydah](https://github.com/ydah)) * concurrent-ruby gem v1.3.5 で `logger` の依存が削除されたことへの対応 ([#72](https://github.com/chocoby/jp_prefecture/pull/72), [@chocoby](https://github.com/chocoby)) ## [1.1.1] - 2022-03-25 -### Bug fix +### Fixed * マッピングに項目が存在しない場合にエラーが発生する問題を修正 ([#59](https://github.com/chocoby/jp_prefecture/pull/59), [@chocoby](https://github.com/chocoby)) ## [1.1.0] - 2022-03-17 -### Features +### Added * 都道府県情報にローマ字表記を追加 ([#57](https://github.com/chocoby/jp_prefecture/pull/57), [@sondh5](https://github.com/sondh5)) * Ruby 3.1 をサポートに追加 ([#54](https://github.com/chocoby/jp_prefecture/pull/54), [@chocoby](https://github.com/chocoby)) @@ -47,20 +44,21 @@ ## [1.0.0] - 2021-02-24 -### Misc +### Changed * 毎週月曜日の 09:00 (JST) にテストを実行する ([#52](https://github.com/chocoby/jp_prefecture/pull/52), [@chocoby](https://github.com/chocoby)) ## [1.0.0.rc1] - 2021-02-10 -### Breaking changes +### Added -* Ruby 1.9.3 - 2.3/Rails 3.2 - 4.2 のサポートを終了 ([#39](https://github.com/chocoby/jp_prefecture/pull/39), [@chocoby](https://github.com/chocoby)) +* Ruby 3.0 をサポートに追加 ([#42](https://github.com/chocoby/jp_prefecture/pull/42), [@chocoby](https://github.com/chocoby)) +* `JpPrefecture::Prefecture` クラスに都道府県コードから都道府県インスタンスを作成する `build_by_code` メソッドを追加 ([#44](https://github.com/chocoby/jp_prefecture/pull/44), [@chocoby](https://github.com/chocoby)) - 古い Ruby/Rails のサポートを終了しました。今後も大きな不具合が見つかった場合、可能な限りは対応する予定です。 + 都道府県コードを指定すると、それに対応した都道府県の `JpPrefecture::Prefecture` インスタンスを取得するメソッドを追加しました。 + `JpPrefecture::Prefecture.build` メソッドは参照している処理がなくなったため、削除しました。 - サポートするバージョンの範囲は Ruby/Rails のメンテナンスポリシーに則るのがシンプルですが、この Gem では厳しくする必要はないと考えています。 - Ruby/Rails のメンテナンスポリシーで決められているバージョンは最低限サポートし、実装やテストのメンテナンスが困難になったバージョンからサポートを終了する方針で検討しています。ご意見があればください。 +### Changed * 文字列による検索は項目を指定して検索する ([#43](https://github.com/chocoby/jp_prefecture/pull/43), [#24](https://github.com/chocoby/jp_prefecture/issues/24), [#27](https://github.com/chocoby/jp_prefecture/issues/27), [@chocoby](https://github.com/chocoby)) @@ -68,23 +66,19 @@ 対応として、`name` を指定した場合は漢字表記、`name_e` は英語表記など、指定した項目のみを検索するように変更しました。詳しい使い方は README を参照してください。 以前のように、すべての項目から検索したい場合は `JpPrefecture::Prefecture.find(all_fields: 'string')` を使用してください。 -### Features - -* Ruby 3.0 をサポートに追加 ([#42](https://github.com/chocoby/jp_prefecture/pull/42), [@chocoby](https://github.com/chocoby)) * 郵便番号データを更新 ([#46](https://github.com/chocoby/jp_prefecture/pull/46), [@chocoby](https://github.com/chocoby)) -* `JpPrefecture::Prefecture` クラスに都道府県コードから都道府県インスタンスを作成する `build_by_code` メソッドを追加 ([#44](https://github.com/chocoby/jp_prefecture/pull/44), [@chocoby](https://github.com/chocoby)) - - 都道府県コードを指定すると、それに対応した都道府県の `JpPrefecture::Prefecture` インスタンスを取得するメソッドを追加しました。 - `JpPrefecture::Prefecture.build` メソッドは参照している処理がなくなったため、削除しました。 +* CONTRIBUTING.md を追加 ([#41](https://github.com/chocoby/jp_prefecture/pull/41), [@chocoby](https://github.com/chocoby)) +* RuboCop を導入 ([#40](https://github.com/chocoby/jp_prefecture/pull/40), [@chocoby](https://github.com/chocoby)) +* Gem に含めるファイルを最低限のものにする ([#48](https://github.com/chocoby/jp_prefecture/pull/48), [@chocoby](https://github.com/chocoby)) -### Documentation +### Removed -* CONTRIBUTING.md を追加 ([#41](https://github.com/chocoby/jp_prefecture/pull/41), [@chocoby](https://github.com/chocoby)) +* Ruby 1.9.3 - 2.3/Rails 3.2 - 4.2 のサポートを終了 ([#39](https://github.com/chocoby/jp_prefecture/pull/39), [@chocoby](https://github.com/chocoby)) -### Misc + 古い Ruby/Rails のサポートを終了しました。今後も大きな不具合が見つかった場合、可能な限りは対応する予定です。 -* RuboCop を導入 ([#40](https://github.com/chocoby/jp_prefecture/pull/40), [@chocoby](https://github.com/chocoby)) -* Gem に含めるファイルを最低限のものにする ([#48](https://github.com/chocoby/jp_prefecture/pull/48), [@chocoby](https://github.com/chocoby)) + サポートするバージョンの範囲は Ruby/Rails のメンテナンスポリシーに則るのがシンプルですが、この Gem では厳しくする必要はないと考えています。 + Ruby/Rails のメンテナンスポリシーで決められているバージョンは最低限サポートし、実装やテストのメンテナンスが困難になったバージョンからサポートを終了する方針で検討しています。ご意見があればください。 ## [0.11.0] - 2020-12-18 From ce324547da68b5e124a5a1d0be73050ff915c6d1 Mon Sep 17 00:00:00 2001 From: Kenta Okamoto <85665+chocoby@users.noreply.github.com> Date: Sun, 2 Aug 2026 16:37:55 +0900 Subject: [PATCH 4/6] docs: add changelog header and version comparison links --- CHANGELOG.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 29dae7b..c43d51d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,5 @@ +# Changelog + ## [Unreleased] ### Added @@ -153,3 +155,26 @@ * 都道府県の変換 * 簡単な Rails サポート + +[Unreleased]: https://github.com/chocoby/jp_prefecture/compare/v1.1.2...HEAD +[1.1.2]: https://github.com/chocoby/jp_prefecture/compare/v1.1.1...v1.1.2 +[1.1.1]: https://github.com/chocoby/jp_prefecture/compare/v1.1.0...v1.1.1 +[1.1.0]: https://github.com/chocoby/jp_prefecture/compare/v1.0.0...v1.1.0 +[1.0.0]: https://github.com/chocoby/jp_prefecture/compare/v1.0.0.rc1...v1.0.0 +[1.0.0.rc1]: https://github.com/chocoby/jp_prefecture/compare/v0.11.0...v1.0.0.rc1 +[0.11.0]: https://github.com/chocoby/jp_prefecture/compare/v0.10.0...v0.11.0 +[0.10.0]: https://github.com/chocoby/jp_prefecture/compare/v0.9.0...v0.10.0 +[0.9.0]: https://github.com/chocoby/jp_prefecture/compare/v0.8.1...v0.9.0 +[0.8.1]: https://github.com/chocoby/jp_prefecture/compare/v0.8.0...v0.8.1 +[0.8.0]: https://github.com/chocoby/jp_prefecture/compare/v0.7.0...v0.8.0 +[0.7.0]: https://github.com/chocoby/jp_prefecture/compare/v0.6.0...v0.7.0 +[0.6.0]: https://github.com/chocoby/jp_prefecture/compare/v0.5.0...v0.6.0 +[0.5.0]: https://github.com/chocoby/jp_prefecture/compare/v0.4.0...v0.5.0 +[0.4.0]: https://github.com/chocoby/jp_prefecture/compare/v0.3.2...v0.4.0 +[0.3.2]: https://github.com/chocoby/jp_prefecture/compare/v0.3.1...v0.3.2 +[0.3.1]: https://github.com/chocoby/jp_prefecture/compare/v0.3.0...v0.3.1 +[0.3.0]: https://github.com/chocoby/jp_prefecture/compare/v0.2.0...v0.3.0 +[0.2.0]: https://github.com/chocoby/jp_prefecture/compare/v0.1.1...v0.2.0 +[0.1.1]: https://github.com/chocoby/jp_prefecture/compare/v0.1.0...v0.1.1 +[0.1.0]: https://github.com/chocoby/jp_prefecture/compare/v0.0.1...v0.1.0 +[0.0.1]: https://github.com/chocoby/jp_prefecture/releases/tag/v0.0.1 From b8b90de00cf79e0453bee7efd42078869cfd38d3 Mon Sep 17 00:00:00 2001 From: Kenta Okamoto <85665+chocoby@users.noreply.github.com> Date: Sun, 2 Aug 2026 16:53:01 +0900 Subject: [PATCH 5/6] docs: record merged PRs in unreleased section --- CHANGELOG.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index c43d51d..5b09958 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,22 @@ * Rails 8.1 をサポートに追加 ([#78](https://github.com/chocoby/jp_prefecture/pull/78), [@chocoby](https://github.com/chocoby)) * Ruby 4.0 をサポートに追加 ([#80](https://github.com/chocoby/jp_prefecture/pull/80), [@chocoby](https://github.com/chocoby)) +* 前方一致するすべての都道府県を返す `JpPrefecture::Prefecture.where` を追加 ([#90](https://github.com/chocoby/jp_prefecture/pull/90), [@chocoby](https://github.com/chocoby)) + +### Changed + +* RuboCop の `TargetRubyVersion` を RuboCop がサポートする Ruby 2.7 に変更 ([#75](https://github.com/chocoby/jp_prefecture/pull/75), [@chocoby](https://github.com/chocoby)) +* Dependabot で GitHub Actions を更新するようにした ([#76](https://github.com/chocoby/jp_prefecture/pull/76), [@chocoby](https://github.com/chocoby)) +* テストする Ruby/Rails の組み合わせを代表的なものに絞る ([#82](https://github.com/chocoby/jp_prefecture/pull/82), [@chocoby](https://github.com/chocoby)) +* 郵便番号データを毎月更新するワークフローを追加 ([#85](https://github.com/chocoby/jp_prefecture/pull/85), [@chocoby](https://github.com/chocoby)) +* リリース時に RubyGems へ gem を自動公開するようにした ([#88](https://github.com/chocoby/jp_prefecture/pull/88), [@chocoby](https://github.com/chocoby)) + +### Fixed + +* カスタムの `zip_mapping_data` で範囲検索が動作しない問題を修正 ([#83](https://github.com/chocoby/jp_prefecture/pull/83), [@chocoby](https://github.com/chocoby)) +* `ken_all.zip` のダウンロード URL を修正/郵便番号データ更新 ([#84](https://github.com/chocoby/jp_prefecture/pull/84), [@chocoby](https://github.com/chocoby)) +* `KEN_ALL.CSV` の参照時に大文字小文字が一致せず Linux で rake タスクが失敗する問題を修正 ([#86](https://github.com/chocoby/jp_prefecture/pull/86), [@chocoby](https://github.com/chocoby)) +* 都道府県名の検索で String 以外の値を渡すとエラーになる問題を修正 ([#89](https://github.com/chocoby/jp_prefecture/pull/89), [@chocoby](https://github.com/chocoby)) ## [1.1.2] - 2025-02-24 From a025ecf18da57f42095dae69f12b4bc296ebf3f9 Mon Sep 17 00:00:00 2001 From: Kenta Okamoto <85665+chocoby@users.noreply.github.com> Date: Sun, 2 Aug 2026 16:38:03 +0900 Subject: [PATCH 6/6] docs: document changelog conventions and release link updates --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a25a710..27b9c4a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,14 +65,49 @@ RuboCop でコーディングスタイルをチェックします。警告が出 bundle exec rubocop -A ``` +## CHANGELOG の書き方 + +`CHANGELOG.md` は [Keep a Changelog](https://keepachangelog.com/ja/1.1.0/) に準拠します。 + +変更を加えた Pull Request では、`## [Unreleased]` に 1 行追記してください。 + +### 変更種別 + +以下の 6 種類から選び、この順序で並べます。該当のない種別は書きません。 + +| 種別 | 対象 | +| --- | --- | +| `Added` | 新機能、新 API、新しい Ruby/Rails サポートの追加 | +| `Changed` | 既存挙動の変更、データ更新、依存の更新、CI/lint/ドキュメントの変更 | +| `Deprecated` | 将来削除予定の機能の非推奨化 | +| `Removed` | 機能の削除、サポートバージョンの終了 | +| `Fixed` | バグ修正 | +| `Security` | 脆弱性の修正 | + +破壊的変更のための専用の種別は設けていません。`Removed` または `Changed` に置き、破壊的である旨と移行方法を本文で説明してください。 + +### エントリの書き方 + +``` +* Rails 8.1 をサポートに追加 ([#78](https://github.com/chocoby/jp_prefecture/pull/78), [@chocoby](https://github.com/chocoby)) +``` + +- 説明は日本語で書く +- 括弧内は PR/Issue のリンクを先に並べ、作者のリンクを最後に置き、`, ` で区切る +- 補足が必要な場合は、2 スペースインデントの段落を続ける + ## リリース手順 gem の公開は GitHub Actions の `release` ワークフローが行います。ローカルで `gem push` を実行する必要はありません。 1. `lib/jp_prefecture/version.rb` のバージョンを変更 - バージョニングは [セマンティックバージョニング](https://semver.org/lang/ja/) に則る -1. `CHANGELOG.md` の `## Unreleased` を `## X.Y.Z (YYYY-MM-DD)` に変更 - - リリースノートはこの節の内容がそのまま使われる +1. `CHANGELOG.md` を更新 + - `## [Unreleased]` を `## [X.Y.Z] - YYYY-MM-DD` に変更する + - 新しい空の `## [Unreleased]` をヘッダ直後に追加する + - ファイル末尾の `[Unreleased]:` を `compare/vX.Y.Z...HEAD` に張り替える + - ファイル末尾に `[X.Y.Z]: https://github.com/chocoby/jp_prefecture/compare/v<前バージョン>...vX.Y.Z` を追加する + - リリースノートは `## [X.Y.Z]` 節の内容がそのまま使われる 1. main ブランチに対して Pull Request を作成 - CI がパスしたらマージ 1. [Releases](https://github.com/chocoby/jp_prefecture/releases) で新しいリリースを作成