Skip to content

Commit 73c784c

Browse files
feat: add CHANGELOG.md for documenting notable changes and versioning
1 parent 70dc4e3 commit 73c784c

File tree

2 files changed

+29
-3
lines changed

2 files changed

+29
-3
lines changed

CHANGELOG.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Changelog
2+
3+
All notable changes to **CPython Patch PR Action** will be documented here.
4+
The project follows [Semantic Versioning](https://semver.org/) and adheres to the
5+
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format.
6+
7+
## [Unreleased]
8+
9+
### Added
10+
11+
- GitHub Action scaffold with TypeScript build, lint, test, and bundling pipelines.
12+
- Metadata inputs for `track`, `include_prerelease`, `paths`, `automerge`, `dry_run`,
13+
and optional external PR support.
14+
- Version discovery modules covering CPython tag fetchers, python.org fallback,
15+
runner availability checks, track alignment, pre-release guard, and idempotence.
16+
- Repo scanning engine with glob discovery, pattern matchers, dry-run summaries,
17+
targeted rewrite logic, and patch computation.
18+
- Git automation utilities for branch creation, commits, and duplicate-safe pull
19+
requests via Octokit.
20+
- Initial README, security, contributing, and roadmap documentation optimized for
21+
SEO and onboarding.
22+
23+
### Planned
24+
25+
- First tagged release (`v0.x`) once end-to-end automation is validated in sandbox repositories.
26+
- Automated changelog updates during release workflows.

docs/tasks.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -171,9 +171,9 @@ Use Context7 MCP for up to date documentation.
171171
Include minimal and guarded examples, inputs/outputs tables, permissions, FAQs.
172172
Verify: `actionlint` validates examples.
173173

174-
24. [ ] **CHANGELOG and versioning**
175-
Keep `CHANGELOG.md`. Plan `v0.x` then `v1`.
176-
Verify: Release notes generated on tag.
174+
24. [x] **CHANGELOG and versioning**
175+
Keep `CHANGELOG.md`. Plan `v0.x` then `v1`.
176+
Verify: Release notes generated on tag.
177177

178178
25. [ ] **Action icon and color**
179179
Update `action.yml` branding.

0 commit comments

Comments
 (0)