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

[Automated] Merge release into main #146

Merged
merged 15 commits into from
Jul 21, 2024
Merged

[Automated] Merge release into main #146

merged 15 commits into from
Jul 21, 2024

Conversation

ProKil
Copy link
Member

@ProKil ProKil commented Jul 20, 2024

Automated Pull Request.

This PR also pins mypy version to avoid its latest bug. python/mypy#17543

@ProKil ProKil self-assigned this Jul 20, 2024
Copy link

codecov bot commented Jul 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.78%. Comparing base (701f2a8) to head (e4f0a26).
Report is 7 commits behind head on main.

@@            Coverage Diff             @@
##             main     #146      +/-   ##
==========================================
- Coverage   61.71%   60.78%   -0.93%     
==========================================
  Files          55       55              
  Lines        2714     3295     +581     
==========================================
+ Hits         1675     2003     +328     
- Misses       1039     1292     +253     

see 7 files with indirect coverage changes

@ProKil ProKil requested a review from XuhuiZhou July 20, 2024 13:04
@@ -49,7 +49,7 @@ ruff = "*"
pytest = "*"
pytest-cov = "*"
pytest-asyncio = "*"
mypy = "^1.8.0"
mypy = ">=1.8.0,<1.11.0"
Copy link
Member

Choose a reason for hiding this comment

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

I thought 1.11.0 is the buggy version?

Copy link
Member Author

Choose a reason for hiding this comment

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

so <1.11.0 is the right range.

branches:
- 'release'

jobs:
Copy link
Member

Choose a reason for hiding this comment

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

what does this do? I thought the main should be the most updated branch? Or it's more like the release branch simply changes the version name?

Copy link
Member Author

Choose a reason for hiding this comment

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

We can use a different model, but I am using the following method:

  1. Our main branch is the develop branch, which accepts reviewed PRs (feature/bug fix). Nobody can push anything to main directly without a PR;
  2. When main branch has enough features for a new release, a release branch is created. After minimal preparation, e.g. bumping versions, CHANGELOG, etc., the core maintainers push a tag to release, which submits the package to PyPI;
  3. after the release branch is tagged, we should merge the release branch back to master (which was not automated previously, but this PR automates this process).

i.e. main has the latest features, release branch is for preparation for a release. Since we strictly ban direct commits to main, the tags are pushed to release.

Copy link
Member

Choose a reason for hiding this comment

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

Cool, thanks for the explanation! I think this is worthwhile to add to the contribution doc, which I will do that.

branches:
- 'release'

jobs:
Copy link
Member

Choose a reason for hiding this comment

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

Cool, thanks for the explanation! I think this is worthwhile to add to the contribution doc, which I will do that.

@XuhuiZhou XuhuiZhou merged commit c992b1c into main Jul 21, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants