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.

Sign up for GitHub

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

Jump to bottom

fix: improve release process and documentation #34

Merged
merged 3 commits into from
Nov 10, 2024
Merged

fix: improve release process and documentation #34

merged 3 commits into from
Nov 10, 2024

Conversation

Bjarten
Copy link
Owner

@Bjarten Bjarten commented Nov 10, 2024 •
edited
Loading

Description

This PR improves the release process and documentation by:

  1. Makes tag pushing explicit in the release workflow
  2. Fixes version management in semantic release
  3. Updates README with PyPI installation instructions

Changes

  • Added explicit tag pushing parameters to semantic-release workflow
  • Updated version management in pyproject.toml:
    • Added version_toml configuration
    • Changed from dynamic to static versioning
    • Set version to match current release (1.0.1)
  • Updated README.md:
    • Added PyPI installation instructions
    • Fixed image URL for PyPI compatibility
    • Reorganized installation and usage sections

@Bjarten Bjarten changed the title fix: release workflow and versioning fix: improve release process and documentation Nov 10, 2024
@Bjarten Bjarten merged commit f42d5d1 into main Nov 10, 2024
7 checks passed
@Bjarten Bjarten deleted the fix/release-workflow branch November 10, 2024 11:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Bjarten