Add github action to automate updates to releases pages
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 42/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- ci-cd, documentation, release
Research direction
Start by reading scripts/generate-release-notes.sh and scripts/release-to-hugo.py to understand how release pages are generated and skipped when they already exist. The work is done when a GitHub Action runs the generation on a regular or release-triggered basis and opens a pull request when release-page files are updated.
Written by the indexing model from the issue text.
Description
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.
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.
- Dominant language
- Python
- Stars
- 8
- Forks
- 12
- Avg merge
- 3m
- Merged PRs (30d)
- 23
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from anchore/oss-docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
Mariner Linux is an alias of Azure Linux (really a pre-release code name) but our data doesn't reflect thisPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 1/5 1-3 hours Newbie friendliness 55/100
Maintainers usually reply within 1 day
All issues in anchore/oss-docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
fritzprix/libr-agent#2612 ·
Maintainers usually reply within 1 day
-
needs-triage presubmit-gate
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
gke-labs/kube-agents#5001 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
simonw/sqlite-utils#928 ·
Maintainers usually reply within 3 days
-
colorado
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
freelawproject/juriscraper#2405 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
cline/mcp-marketplace#3576 ·