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 workflow for publishing releases #19

Merged
merged 4 commits into from
Jan 29, 2025
Merged

add workflow for publishing releases #19

merged 4 commits into from
Jan 29, 2025

Conversation

axl1313
Copy link
Collaborator

@axl1313 axl1313 commented Jan 29, 2025

  • Adds workflow to build package, publish to PyPI, and create release on GitHub when new tag is pushed. Workflow verifies that tag version matches version in __about__.py
  • Adds instructions in DEVELOPMENT.md for creating new release
  • Adds CHANGELOG.md

@axl1313 axl1313 force-pushed the feat/publish-workflow branch 8 times, most recently from 19a0716 to 68656a4 Compare January 29, 2025 22:09
@axl1313 axl1313 force-pushed the feat/publish-workflow branch from 68656a4 to afa2796 Compare January 29, 2025 22:50
@axl1313 axl1313 changed the title Feat/publish workflow add workflow for automated releases Jan 29, 2025
@axl1313 axl1313 changed the title add workflow for automated releases add workflow for publishing releases Jan 29, 2025
@axl1313 axl1313 marked this pull request as ready for review January 29, 2025 22:54
@axl1313 axl1313 merged commit 6304b34 into main Jan 29, 2025
8 checks passed
Comment on lines +16 to +17
[Unreleased]: https://github.com/cleanlab/cleanlab-codex/compare/v0.0.1a1...HEAD
[0.0.1a1]: https://github.com/cleanlab/cleanlab-codex/compare/267a93300f77c94e215d7697223931e7926cad9e...v0.0.1a1
Copy link
Contributor

Choose a reason for hiding this comment

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

@axl1313 do these links need to be manually updated as well? (I'm bumping the version in my refactor PR)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good question! Yeah they do. It'll just be updating the base commit for the [Unreleased] link to the new version tag and adding a link underneath the [Unreleased] link for the new version. Mind updating the DEVELOPMENT.md to mention this as well :)

Copy link
Contributor

Choose a reason for hiding this comment

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

yep I'll update DEVELOPMENT.md too! to confirm - I need to merge my PR first, and then create a 2nd PR to bump the version, right? because otherwise I won't have the squashed commit ID to reference in the link for my new version

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think you could do it as part of the same PR, since the link uses the tag rather than the actual commit hash. The link will just be broken for a little until you push the new tag

Copy link
Contributor

Choose a reason for hiding this comment

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

yeah good call! I updated it in my branch

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