Skip to content

リリースドキュメントの改善 #76

@negokaz

Description

@negokaz

次の PR でリリース手順が明文化されました。

この手順に沿ってリリース作業を実施しましたが、いくつか気になる点がありました。

PR テンプレートを適用するには URL にパラメータを追加する必要がある

プロジェクトに複数の PR テンプレートを作成した場合、それぞれのテンプレートを適用するには PR を作成するページの URL のパラメータでテンプレートを指定する方法しかないようです。

また、template クエリパラメータでプルリクエストの本文に使用するテンプレートを指定できます。

リポジトリ用のプルリクエストテンプレートの作成 - GitHub Docs

テンプレートを複数使い分けたい場合

GitHub で pull request のテンプレートを複数使いわける - Qiita

現在の次のような書き方ではそのことを読み取るのが難しいと思われるので、説明を追加するなどの改善をしたほうが良さそうに思います。

Create a new PR with the releasing.md PR Template after pushing the branch:

lerna-app-library/RELEASING.md at main · lerna-stack/lerna-app-library

PR のコメントではアンカーが生成されないため、ToDo リストのリンクが無効

実害はないので、このままでも良さそうですが、念のため記録しておきます。

PR テンプレート releasing.md では ToDo リストの項目にアンカーへのリンクが指定されています。しかし、PR にテンプレートを適用すると、PR のコメント中ではアンカーが生成されないため項目のリンクが無効になります。

例:

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions