Skip to content

Commit f773e7d

Browse files
committed
Add github PR template for new release workflow checklist
Signed-off-by: lelia <lelia@socket.dev>
1 parent b55b0b6 commit f773e7d

2 files changed

Lines changed: 27 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Summary
2+
3+
<!-- What does this PR do? Why? -->
4+
5+
## Changes
6+
7+
<!-- Bullet points are fine. Link to relevant issues/tickets if applicable. -->
8+
9+
## Testing
10+
11+
<!-- How was this tested? Local smoke test, CI, manual verification, etc. -->
12+
13+
---
14+
15+
### Release checklist (skip for non-release PRs)
16+
17+
<!-- Only fill this out if this PR is cutting a new release (e.g. v2.1.0). -->
18+
19+
- [ ] `socket_basics/version.py` updated to new version
20+
- [ ] `pyproject.toml` updated to match
21+
- [ ] `action.yml` `image:` ref updated to `docker://ghcr.io/socketdev/socket-basics:<new-version>`
22+
- [ ] `CHANGELOG.md` `[Unreleased]` section reviewed and accurate
23+
24+
> ⚠️ **After merging:** run `publish-docker.yml` via `workflow_dispatch` with the new version
25+
> **before** creating the git tag. The image must exist in GHCR before the tag is pushed.
26+
> See [Release workflow](../docs/github-action.md#release-workflow-publish--tag-never-tag--publish) for the full process.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ logs/
8989
!CHANGELOG.md
9090
!docs/*.md
9191
!tests/README.md
92+
!.github/PULL_REQUEST_TEMPLATE.md
9293

9394
# Project-specific (local scripts and test files)
9495
test/

0 commit comments

Comments
 (0)