Add github action to automate updates to releases pages

オープン
#4 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

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

調査の方向性

まず scripts/generate-release-notes.sh と scripts/release-to-hugo.py を読んで、release ページがどのように生成され、すでに存在する場合にスキップされるのかを理解します。GitHub Action が定期的に、または release をトリガーとして生成を実行し、release ページのファイルが更新されたときに pull request を開くようになれば、作業は完了です。

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

説明

The "Releases" pages contain a mirror of the information typically found in the GitHub release pages for each application. This information is reproduced within the docs pages to ensure people can find it without having to go off-site to GitHub when looking for this dynamic information.

Image

The script scripts/generate-release-notes.sh wraps scripts/release-to-hugo.py to generate the pages:

$ scripts/generate-release-notes.sh
Processing syft with weight 10...
Fetching releases from anchore/syft on GitHub...
Found 213 releases
Skipping existing release: v1.32.0 (already exists)
Skipping existing release: v1.31.0 (already exists)
Skipping existing release: v1.30.0 (already exists)
Skipping existing release: v1.29.1 (already exists)

Skipping existing release: v0.1.0-beta.5 (already exists)
Skipping existing release: v0.1.0-beta.4 (already exists)
Skipping existing release: v0.1.0-beta.3 (already exists)
Skipping existing release: v0.1.0-beta.2 (already exists)
Skipping existing release: v0.1.0-beta.1 (already exists)
Done!
✅ Successfully generated release notes for syft
-----------------------------------
Processing grype with weight 20...
Fetching releases from anchore/grype on GitHub...
Found 174 releases
Skipping existing release: v0.99.1 (already exists)
Skipping existing release: v0.99.0 (already exists)
Skipping existing release: v0.98.0 (already exists)
Skipping existing release: v0.97.2 (already exists)

etc.

It only generates if the existing markdown file isn't already there. If the content/docs/releases/* is removed, then the script will re-generate all of the release notes files. This could be useful if the code/format of the release notes needs to change.

We should replace this with a GitHub action that could be run regularly and generate a pull request when files are updated. It could also be triggered somehow by the releases of our OSS tools.

主要言語
Python
スター
7
フォーク
12
平均マージ
3分
マージ済み PR(30日)
24

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

anchore/oss-docs のほかの issue

anchore/oss-docs の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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