Skip to content

Commit df78597

Browse files
chore: document v1.0.0 release
1 parent 5288d54 commit df78597

File tree

5 files changed

+13
-390
lines changed

5 files changed

+13
-390
lines changed

CHANGELOG.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,17 @@ The project follows [Semantic Versioning](https://semver.org/) and adheres to th
66

77
## [Unreleased]
88

9-
### Added
9+
- Nothing yet.
1010

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.
11+
## [1.0.0] - 2025-02-14
2212

23-
### Planned
13+
### Added
2414

25-
- First tagged release (`v0.x`) once end-to-end automation is validated in sandbox repositories.
26-
- Automated changelog updates during release workflows.
15+
- First official, production-ready release of the CPython Patch PR Action.
16+
- Comprehensive repository scanner covering GitHub workflows, Dockerfiles, `.python-version`, `.tool-versions`, `runtime.txt`, `pyproject.toml`, `Pipfile`, Conda `environment.yml`, `tox.ini`, and more.
17+
- Rewrite engine that computes minimal diffs, preserves suffixes (e.g. `-slim`), supports dry-run previews, and ensures idempotent reruns.
18+
- Version resolution pipeline combining GitHub tag discovery, python.org fallback, runner availability verification, track alignment, and configurable pre-release guard.
19+
- Git automation that creates or reuses `chore/bump-python-<track>` branches, commits file updates, and opens or updates pull requests with detailed bodies and rollback instructions.
20+
- Security keyword gating that inspects CPython release notes before applying upgrades, with offline snapshot support for air-gapped environments.
21+
- Outputs for downstream automation, including `files_changed`, `new_version`, `skipped_reason`, and the `change_matrix` JSON for CI matrix fan-out.
22+
- Cross-platform compatibility through normalized path handling and Windows coverage in the continuous integration workflow.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ We will adopt TypeScript and follow the formatting enforced by Prettier and ESLi
2121

2222
## Documentation
2323

24-
Update relevant documentation (README, docs/) when you introduce user-facing changes or new configuration options.
24+
Update relevant documentation (e.g. the README) when you introduce user-facing changes or new configuration options.

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
CPython Patch PR Action is a GitHub Action that automatically scans your repository for pinned CPython patch versions (e.g. `3.12.4`) and opens an evergreen pull request whenever a new patch release is available. It keeps Dockerfiles, GitHub workflows, `.python-version`, `pyproject.toml`, `runtime.txt`, `Pipfile`, Conda environment files, and more aligned with the latest stable runtime—helping teams maintain secure, up-to-date Python environments without custom automation.
44

5-
> **Status:** Active development. Version discovery, rewriting, dry-run summaries, branch/PR automation, and guardrails are already implemented. Follow `docs/tasks.md` for the remaining milestones.
6-
75
---
86

97
## Quick start
@@ -243,7 +241,7 @@ Pre-releases are ignored unless you set `include_prerelease: true`. The guard pr
243241
The action is laser-focused on CPython patch updates to stay predictable, fast, and audit-friendly.
244242

245243
**How do I see progress?**
246-
Follow `docs/tasks.md`. Each numbered task explains the feature, tooling, and verification steps completed.
244+
Check `CHANGELOG.md` for release history and upcoming highlights.
247245

248246
---
249247

docs/context.md

Lines changed: 0 additions & 101 deletions
This file was deleted.

0 commit comments

Comments
 (0)