gbowne1/json-maestro

[Internal Feat] Changelog CI

Open

#55 opened on Dec 13, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (2 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (4 stars)
PR merge metrics
 (PR metrics pending)

Description

Our CHANGELOG.md leaves a bit to be desired as we do releases. Not something necessarily required but.. it makes changes visible in the GitHub Releases we use.

We could automate this using a action or workflow during CI..

https://stefanzweifel.dev/posts/2021/11/13/introducing-the-changelog-updater-action/

This is one example.. there's others.

Contributor guide

Research direction
Implement a GitHub Action workflow to automatically update CHANGELOG.md on each release, using the changelog updater action or similar.
Tech stack
pythongithub actions
Domain
devopsci cd
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80