Skip to content

feat: Add release please to handle releases #45

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

Merged
merged 4 commits into from
Nov 15, 2022
Merged

Conversation

ajhelsby
Copy link
Contributor

This PR

Add the release please action to handle release versioning

Related Issues

Notes

Follow-up Tasks

How to test

Signed-off-by: Andrew Helsby <[email protected]>

Signed-off-by: Andrew Helsby <[email protected]>
Copy link
Member

@beeme1mr beeme1mr left a comment

Choose a reason for hiding this comment

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

You may want to consider adding a release-please-config.json to the root of the project. You can reuse most of the settings found here. You'll just need to change the release type and bootstrap sha.

Finally, you can use release please to bump versions in the readme. You just need to add them to the config like this and add comments to the files that need to have a version bumped on release. You can see an example here.

Please let me know if you have any questions.

@codecov-commenter
Copy link

codecov-commenter commented Nov 11, 2022

Codecov Report

Merging #45 (2310e11) into main (1e82122) will decrease coverage by 0.75%.
The diff coverage is 92.18%.

@@            Coverage Diff             @@
##             main      #45      +/-   ##
==========================================
- Coverage   93.59%   92.83%   -0.76%     
==========================================
  Files          17       18       +1     
  Lines         281      321      +40     
==========================================
+ Hits          263      298      +35     
- Misses         18       23       +5     
Flag Coverage Δ
unittests 92.83% <92.18%> (-0.76%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
open_feature/exception/exceptions.py 79.16% <66.66%> (-3.19%) ⬇️
open_feature/provider/provider.py 74.07% <83.33%> (-0.93%) ⬇️
open_feature/open_feature_client.py 96.25% <95.23%> (-0.86%) ⬇️
...n_feature/evaluation_context/evaluation_context.py 90.00% <100.00%> (ø)
...feature/flag_evaluation/flag_evaluation_options.py 100.00% <100.00%> (ø)
open_feature/flag_evaluation/flag_type.py 100.00% <100.00%> (ø)
open_feature/provider/no_op_provider.py 100.00% <100.00%> (ø)
open_feature/flag_evaluation/error_code.py
open_feature/exception/error_code.py 100.00% <0.00%> (ø)
... and 1 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

…ease please

Signed-off-by: Andrew Helsby <[email protected]>

Signed-off-by: Andrew Helsby <[email protected]>
Copy link
Member

@beeme1mr beeme1mr left a comment

Choose a reason for hiding this comment

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

I think this should work. The last part missing is the release please comments in the readme. You can see an example here. This part is required or it won't automatically bump the version in the readme as part of the release process.

@beeme1mr
Copy link
Member

It's also worth mentioning that Release Please works off semantic commits. Most of the repos use a PR title validator and perform squash merges. I'm happy to help set that up if you're interested.

@ajhelsby
Copy link
Contributor Author

It's also worth mentioning that Release Please works off semantic commits. Most of the repos use a PR title validator and perform squash merges. I'm happy to help set that up if you're interested.

I believe this has already been set up here https://github.com/open-feature/python-sdk/blob/main/.github/workflows/lint-pr.yml

Signed-off-by: Andrew Helsby <[email protected]>

Signed-off-by: Andrew Helsby <[email protected]>
@toddbaert toddbaert self-requested a review November 14, 2022 19:49
Copy link
Member

@toddbaert toddbaert left a comment

Choose a reason for hiding this comment

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

LGTM as well, but these things usually take some troubleshooting 🤞

@ajhelsby ajhelsby merged commit 5bc0571 into main Nov 15, 2022
@ajhelsby ajhelsby deleted the feature/release-please branch November 15, 2022 11:28
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.

4 participants