-
Notifications
You must be signed in to change notification settings - Fork 23
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
@@ 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 |
@@ -49,7 +49,7 @@ ruff = "*" | |||
pytest = "*" | |||
pytest-cov = "*" | |||
pytest-asyncio = "*" | |||
mypy = "^1.8.0" | |||
mypy = ">=1.8.0,<1.11.0" |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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: |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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:
- Our main branch is the develop branch, which accepts reviewed PRs (feature/bug fix). Nobody can push anything to main directly without a PR;
- 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;
- 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.
There was a problem hiding this comment.
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: |
There was a problem hiding this comment.
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.
Automated Pull Request.
This PR also pins mypy version to avoid its latest bug. python/mypy#17543