Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release instructions #29

Merged
merged 2 commits into from
Dec 16, 2024
Merged

Add release instructions #29

merged 2 commits into from
Dec 16, 2024

Conversation

crimsonknave
Copy link
Collaborator

Adding a quick run down of how to release to pypi.

@Copilot Copilot bot review requested due to automatic review settings December 12, 2024 16:38
@crimsonknave crimsonknave requested a review from a team as a code owner December 12, 2024 16:38

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 1 out of 1 changed files in this pull request and generated no suggestions.

Comments skipped due to low confidence (1)

CONTRIBUTING.md:42

  • The instruction to 'run git tag --sign v0.0.0' should clarify that the tag must be signed with a GPG key that is associated with the user's GitHub account, otherwise the tag creation will fail.
Simply run `git tag --sign v0.0.0` (inserting the correct version). Then, `git push origin v0.0.0`. CI will build, publish to Pypi and then create a GitHub Release with the artifacts.

Tip: Copilot only keeps its highest confidence comments to reduce noise and keep you focused. Learn more

Copy link

Coverage report

This PR does not seem to contain any modification to coverable code.

@crimsonknave crimsonknave merged commit 61f0b6a into main Dec 16, 2024
24 of 25 checks passed
@crimsonknave crimsonknave deleted the pypi-docs branch December 16, 2024 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants