brainstorming
brainstorming
You MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).
release-package-versionRパッケージのリリースサイクルをすべてとおしてI実行する。バージョンバンプ、 NEWS.mdの更新、gitタグ付け、GitHubリリースの作成、リリース後の開発バージョン設定を含む。 パッケージが新しいパッチ、マイナー、またはメジャーリリースの準備完了時、 CRANへの承認後に対応するGitHubリリースを作成する時、またはリリース直後に 開発バージョンバンプを設定する時に使用する。
Independent GitHub snapshot · Automated classification · Original documentation governs
Rパッケージの完全なバージョンリリースサイクルを実行する。
submit-to-cranスキルを使用)セマンティックバージョニングに従う:
| 変更タイプ | バージョンバンプ | 例 |
|---|---|---|
| バグ修正のみ | Patch | 0.1.0 -> 0.1.1 |
| 新機能(後方互換) | Minor | 0.1.0 -> 0.2.0 |
| 破壊的変更 | Major | 0.1.0 -> 1.0.0 |
期待結果: 最後のリリース以降の変更の性質に基づいて正しいバンプタイプ(patch、minor、またはmajor)が決定される。
失敗時: 不明な場合は最後のタグ以降のgit logを確認して各変更を分類する。API破壊的変更はメジャーバンプが必要。
usethis::use_version("minor") # or "patch" or "major"
これによりDESCRIPTIONのVersionフィールドが更新され、NEWS.mdに見出しが追加される。
期待結果: DESCRIPTIONのバージョンが更新される。NEWS.mdにリリースバージョンの新しいセクション見出しが追加される。
失敗時: usethis::use_version()が利用できない場合、DESCRIPTIONのVersionフィールドを手動で更新し、NEWS.mdに# packagename x.y.z見出しを追加する。
新しいバージョン見出しの下にリリースノートを記入する:
# packagename 0.2.0
## New Features
- Added `new_function()` for processing data (#42)
- Support for custom themes in `plot_results()` (#45)
## Bug Fixes
- Fixed crash when input contains all NAs (#38)
- Corrected off-by-one error in `window_calc()` (#41)
## Minor Improvements
- Improved error messages for invalid input types
- Updated documentation examples
トレーサビリティのためにイシュー/PR番号を使用する。
期待結果: NEWS.mdにカテゴリ別に整理されたユーザー向けの変更の完全なまとめが含まれ、トレーサビリティのためにイシュー/PR番号が付いている。
失敗時: 変更の再構築が困難な場合はgit log --oneline v<previous>..HEADを使用して最後のリリース以降のすべてのコミットをリストアップして分類する。
devtools::check()
devtools::spell_check()
urlchecker::url_check()
期待結果: devtools::check()が0エラー、0警告、0ノートを返す。スペルチェックとURLチェックで問題が見つからない。
失敗時: リリース前にすべてのエラーと警告を修正する。スペルチェッカーの誤検知にはinst/WORDLISTに単語を追加する。壊れたURLを置き換える。
git add DESCRIPTION NEWS.md
git commit -m "Release packagename v0.2.0"
期待結果: DESCRIPTIONのバージョンバンプと更新されたNEWS.mdを含む単一のコミット。
失敗時: 他のコミットされていない変更が存在する場合は、DESCRIPTIONとNEWS.mdのみをステージングする。リリースコミットにはバージョン関連の変更のみを含めること。
git tag -a v0.2.0 -m "Release v0.2.0"
git push origin main --tags
期待結果: アノテーション付きタグv0.2.0が作成されてリモートにプッシュされる。git tag -lでローカルにタグが表示され、git ls-remote --tags originでリモートに確認できる。
失敗時: プッシュが失敗する場合は書き込みアクセスがあることを確認する。タグが既に存在する場合はgit show v0.2.0で正しいコミットを指しているか確認する。
gh release create v0.2.0 \
--title "packagename v0.2.0" \
--notes-file NEWS.md
または以下を使用する:
usethis::use_github_release()
期待結果: リポジトリのReleasesページにリリースノートが表示されたGitHubリリースが作成される。
失敗時: gh release createが失敗する場合はgh auth statusでghCLIが認証されているか確認する。usethis::use_github_release()が失敗する場合はGitHubで手動でリリースを作成する。
リリース後、開発バージョンにバンプする:
usethis::use_dev_version()
これにより開発中を示す0.2.0.9000にバージョンが変更される。
git add DESCRIPTION NEWS.md
git commit -m "Begin development for next version"
git push
期待結果: DESCRIPTIONのバージョンが0.2.0.9000(開発バージョン)になる。NEWS.mdに開発バージョンの新しい見出しが追加される。変更がリモートにプッシュされる。
失敗時: usethis::use_dev_version()が利用できない場合、DESCRIPTIONのバージョンを手動でx.y.z.9000に変更し、NEWS.mdに# packagename (development version)見出しを追加する。
R CMD checkがパスするv0.2.0)git pushだけではタグはプッシュされない。--tagsを使用するかgit push origin v0.2.0を使用する.9000バージョンを決して投稿しないことsubmit-to-cran - バージョンリリース後のCRAN投稿create-github-release - 一般的なGitHubリリースの作成setup-github-actions-ci - リリース時にpkgdownの再ビルドをトリガーするbuild-pkgdown-site - ドキュメントサイトが新しいバージョンを反映する