cisagov / cisagov/skeleton-aws-lambda-python

Create automated prerelease/release functionality

オープン
#8 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
github-actions improvement
主要言語
Shell
スター
6
フォーク
2
PR マージ指標
30日以内にマージされた PR はありません

説明

# 💡 Summary #

Add appropriate GitHub Actions workflow functionality to automatically generate a prerelease/release when a corresponding tag is pushed.

## Motivation and context ##

This would automate what is otherwise the tedious job of downloading Actions artifacts, creating a release manually, and uploading the aforementioned artifacts to that release (again manually). It would allow the appropriate GitHub Actions functionality to kick off when a matching tag is pushed to the repository.

## Implementation notes ##

We can leverage the existing [actions/upload-artifact] and [actions/download-artifact] actions to handle generating and sharing the individual Python version artifacts. We can then use something like [softprops/action-gh-release] in conjunction with the [GitHub automated release notes configuration](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) functionality to create an initial release with artifacts attached. The person creating the tag (and thus the prerelease/release) could then simply check the release and make any necessary edits to the release notes if necessary.

## Acceptance criteria ##

- [ ] When a tag is pushed an appropriate prerelease or release is generated

[actions/upload-artifact]: https://github.com/actions/upload-artifact
[actions/download-artifact]:https://github.com/actions/download-artifact
[softprops/action-gh-release]: https://github.com/softprops/action-gh-release

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

まず、リポジトリに既存する GitHub Actions のワークフローと、各 Python バージョンで生成される artifact 名を調査します。upload-artifact と download-artifact アクションを確認し、次に、一致する push 済みタグで prerelease と release をどのように区別するか、またリリースノートをどのように生成するかを判断します。一致する push 済みタグによって、想定された artifact が添付された適切な GitHub release が作成されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
github-actions, python, shell
領域
ci-cd, devops, release
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
42/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。