Skip to content

Commit 4e6d58b

Browse files
JnyJnyclaude
andcommitted
Update documentation to reflect current workflow and command structure
- Fix CLAUDE.md to distinguish between generated project and cookiecutter repo workflows - Update README.md workflow description to match actual release.yaml behavior - Correct README section header from release.yml to release.yaml - Ensure all poe commands and workflow descriptions are accurate and current 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 09239c5 commit 4e6d58b

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

CLAUDE.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,13 @@ Generated projects include comprehensive GitHub automation:
8888

8989
**Workflows:**
9090
- `release.yaml` - Multi-stage CI/CD pipeline with matrix testing and PyPI publishing via trusted publishers
91-
- `github-release.yml` - Automatic GitHub release creation with changelog generation
91+
- `github-release.yml` - Automatic GitHub release creation with changelog generation
9292
- `docs.yml` - GitHub Pages deployment for MkDocs documentation
9393
- `dependabot.yaml` - Automated dependency updates for Python packages and GitHub Actions
9494

95+
**Cookiecutter Repository Workflows:**
96+
- `release.yaml` - Test validation and automatic GitHub release creation with changelog generation
97+
9598
**Issue & PR Templates:**
9699
- Bug report template with structured fields
97100
- Feature request template

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -334,15 +334,14 @@ templates][github-templates]. You should edit them to reflect your
334334
projects needs and personality. You may want to uncomment and edit
335335
issue links in `config.yaml` if it suits your needs.
336336

337-
### .github/workflows/release.yml
338-
339-
The `release.yaml` workflow defines a matrix of operating systems and
340-
Python versions to test against. Tests are run when a [semantic
341-
versioning][semantic-version] tag or a tag with the suffix "-test" is
342-
pushed to a branch. If and when the requested tests complete
343-
successfully, the package will be built and published to PyPI, unless
344-
the triggering tag has a "-test" suffix in which case the workflow
345-
skips publishing.
337+
### .github/workflows/release.yaml
338+
339+
The `release.yaml` workflow runs a fast test subset to validate core
340+
functionality when a [semantic versioning][semantic-version] tag is
341+
pushed. If tests pass successfully, it automatically creates a GitHub
342+
release with generated release notes and changelog integration. This
343+
ensures the cookiecutter template repository itself maintains quality
344+
and provides automated release management.
346345

347346
Tests are designed to be run against matrices of Operating System and
348347
Python version values. The matrices can be a list with a single item

0 commit comments

Comments
 (0)