Correct the release checklist's tag and publishing steps
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 86/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- git, github-actions, python
- Domain
- documentation, release
Research direction
Read docs/development/releasing.md and compare the existing checklist and tagging examples with the four requested changes. Update the guide to document the v* Tag deployment rule for the pypi environment, the pull request and tag workflow, and the hotfix path. Done when both examples use git tag -s and the release steps match the issue.
Written by the indexing model from the issue text.
Description
Change Type
Correction
Proposed Changes
Update docs/development/releasing.md to match the protected-branch release process.
The current git push origin main vX.Y.Z command can push the tag even when the update to main is rejected. If the release changes are later squash-merged or rebased, that tag can remain on the pre-merge commit.
Please update the guide to:
- Document a
v*deployment rule with ref type Tag for thepypienvironment. - Prepare release changes on a branch, merge them through a pull request, then tag the resulting commit on
mainand push only the tag. - Bring hotfixes into
mainthrough a pull request after publication. - Use
git tag -sin both tagging examples, consistent with the signedv0.0.1tag.
- Dominant language
- Python
- Stars
- 8
- Forks
- 0
- Avg merge
- 14h 51m
- Merged PRs (30d)
- 11
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from netbox-community/netbox-scripts
-
app: scripts severity: low status: backlog type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
netbox-community/netbox-scripts#64 ·
Maintainers usually reply within 1 day
-
app: scripts severity: low status: backlog type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
netbox-community/netbox-scripts#62 ·
Maintainers usually reply within 1 day
-
app: scripts status: accepted type: documentation
Difficulty 2/5 Half a day Newbie friendliness 82/100
netbox-community/netbox-scripts#40 · 1 comment · 1 assignee ·
Maintainers usually reply within 1 day
-
app: scripts severity: low status: backlog type: bug
Difficulty 3/5 1-2 days Newbie friendliness 58/100
netbox-community/netbox-scripts#67 ·
Maintainers usually reply within 1 day
-
app: scripts severity: medium status: backlog type: bug
Difficulty 4/5 3-5 days Newbie friendliness 55/100
netbox-community/netbox-scripts#66 ·
Maintainers usually reply within 1 day
All issues in netbox-community/netbox-scripts
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
Validate finite output clamping limits in StepPredictor.prepare_clamping_params to prevent silent NaN/Inf propagationPossibly taken @muskan-creates352 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
mllam/neural-lam#848 ·
Maintainers usually reply within 2 days
-
infra
Difficulty 1/5 Under an hour Newbie friendliness 88/100
fab-geocommuns/RNB-coeur#1166 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
deepspeedai/DeepSpeed#8951 ·
Maintainers usually reply within 2 days