Zenn
🎉

じぶんリリースノートをGitHub Releaseでリリースするカスタムアクション作った

2024/07/27に公開
Go
GitHub Actions
customaction
tech

はじめに

じぶんリリースノートをGitHub Releaseでリリースするカスタムアクションを作りました。
そもそも、じぶんリリースノートとは何かというと

「じぶんりりーすノート」とは

「じぶんリリースノート」とは、個人が自身の活動や成果、成長などを記録するためのノート、またはその記録方法のことです。ソフトウェアの更新履歴を記したリリースノートになぞらえて、自分自身のバージョンアップを記録していくというコンセプトから生まれました。

記載する内容
具体的な内容としては、以下のようなものが挙げられます。

活動記録: その月に取り組んだプロジェクト、学習内容、イベント参加などを記録
成果: 達成できた目標、身につけたスキル、資格取得などを記録
反省点: 課題として残ったこと、改善点などを記録
目標設定: 次の期間に向けての目標、やりたいことなどを記録
KPT: Keep(継続すること), Problem(課題), Try(挑戦すること)をまとめる振り返り手法
その他: 感想、感情、気づきなどを自由に記録

となります。
１ヶ月の振り返りを自分自身をプロダクトとして見ようとすることです。

なにをつくったか？

GitHub Actionsのカスタムアクションです。

https://github.com/o-ga09/zibun-releaser

使い方

じぶんリリースノートのフォーマットは、_example/example.mdに従ってください。

secrets.PATには、リポジトリ環境変数にpersonal access tokenを設定してください。
secrets.APIKEYには、Gemini API KEYをリポジトリ環境変数に設定してください。 (Open AI APIにも対応する予定)
filepathは、リポジトリルートからの相対パスで指定してください。
release-versionは、セマンティックバージョニングに従ってください。

    - name: Use Custom Actions
      uses: o-ga09/zibun-releaser@v0.0.15
      with:
        release-version: '<リリースしたいバージョン>'
        github-token: ${{ secrets.PAT }}
        filepath: "<じぶんリリースノートの元となるmarkdownファイル>"
        apikey: ${{ secrets.APIKEY }}

背景

noteに5月から投稿してはいたのですが、面倒くさいし、なんかGitHub上で、プロダクトのリリースっぽく
できたら便利じゃねとふと思いついて作りました。

多分、バグありそうだし、Open AI APIには対応していないし、まだまだ、対応しなければいけないところがたくさんありそうです。

制作期間

10時間

木、金、土で、2h、2h、6hくらいでした。
ちょっと時間かかったなって感じですが、
GitHub Actionsの理解も深まったのでよしとします。

まとめ

今回はそこそこ、さくっと個人開発で、GitHub Actionsのカスタムアクションを作ってみました。
これからのこのカスタミアクションを使って、じぶんりりーすノートを続けていきます。

Discussion