Skip to content

Conversation

@subhobhai943
Copy link

This PR supersedes PR #40. It reintroduces stable releases and semantic versioning support with the same changes, plus a ruff-compliant release script and minor wording cleanups.

Summary of contents:

  • Add .github/workflows/release.yml for automated tag-based and manual releases
  • Add CHANGELOG.md using Keep a Changelog format
  • Update README with installation and versioning instructions
  • Add docs/RELEASE_PROCESS.md
  • Add scripts/release.py with ruff-compliant fixes and type hints

Context:

- Add type annotations for all functions and parameters
- Add encoding specification for file operations
- Fix subprocess.run calls with check=False for non-critical operations
- Add noqa comments for intentional print statements
- Fix conditional logic to use early returns
- Add docstring for main function
- Use unpacking in subprocess calls
- Use keyword-only arguments where appropriate
- Fix argument formatting and trailing commas
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.

Consider publishing stable tags/releases

1 participant