cisagov / cisagov/skeleton-aws-lambda-python
Create automated prerelease/release functionality
- Ngôn ngữ chính
- Shell
- Star
- 6
- Fork
- 2
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
# 💡 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
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu bằng cách kiểm tra các workflow GitHub Actions hiện có của repository và tên artifact được tạo cho từng phiên bản Python. Xem xét các action upload-artifact và download-artifact, sau đó xác định cách các tag khớp được push phải phân biệt prerelease với release và cách tạo release notes. Hoàn thành khi một tag khớp được push tạo ra GitHub release phù hợp với các artifact dự kiến được đính kèm.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- github-actions, python, shell
- Lĩnh vực
- ci-cd, devops, release
- Loại issue
- Tính năng
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 42/100