Skip to content

Commit a0182d2

Browse files
Fix PyPI workflow tag detection (#57)
- broaden publish tag pattern to catch pre-release tags - update docs to reflect new pattern
1 parent 032109b commit a0182d2

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

.github/workflows/publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Publish Package to PyPI
33
on:
44
push:
55
tags:
6-
- 'v*.*.*' # Matches tags like v1.0.0
6+
- 'v*' # Matches tags like v1.0.0 or v1.0.0b1
77

88
jobs:
99
publish:

docs/contribute.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,14 +179,14 @@ git tag -d v0.0.2
179179

180180
## Build Automation with GitHub Actions
181181

182-
Our project uses GitHub Actions to automate the build and deployment process. When a new tag is pushed to the repository (matching `v*.*.*`), the build bot is triggered to:
182+
Our project uses GitHub Actions to automate the build and deployment process. When a new tag is pushed to the repository (matching `v*`), the build bot is triggered to:
183183

184184
- **Build the Package**: Create source and wheel distributions of the package.
185185
- **Publish to PyPI**: Upload the distributions to PyPI using Twine.
186186

187187
### How the Build Bot Works
188188

189-
1. **Trigger**: The workflow is triggered on pushing tags that match the pattern `v*.*.*`.
189+
1. **Trigger**: The workflow is triggered on pushing tags that match the pattern `v*`.
190190
2. **Workflow File**: The workflow is defined in `.github/workflows/publish.yml` or a similarly named CI file.
191191
3. **Steps**:
192192
- **Checkout Code**: Fetches the repository code and tags.

0 commit comments

Comments
 (0)