-
Notifications
You must be signed in to change notification settings - Fork 6
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
Community #296
Conversation
mastoffel
commented
Feb 5, 2025
•
edited
Loading
edited
- fix links
- create gh-action to publish to pypi
- add release docs for maintainers
change links in CONTRIBUTING to point to docs
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #296 +/- ##
==========================================
- Coverage 94.20% 94.17% -0.03%
==========================================
Files 62 62
Lines 3606 3606
==========================================
- Hits 3397 3396 -1
- Misses 209 210 +1 ☔ View full report in Codecov by Sentry. |
Coverage reportClick to see where and how coverage changed
This report was generated by python-coverage-comment-action |
test release workflow fix workflow fix workflow fix workflow fix test release workflow fix test release workflow fix test release workflow add release workflow
@marjanfamili @radka-j . I've added a gh-action workflow to automatically release the package on PyPi when pushing a new version tag as suggested in #287. To make this clear, I added a guide in the documentation (docs/community/release.md). I'm just wondering now whether this should just be under "community" as releasing requires maintainer rights, or whether we should have a seperate maintainer section or so for this. Would do you think? |
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.
LGTM
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.
Looks great! The updated links work for me.
Only thought I had was whether there are any versioning guidelines we follow that we can link to in the release section? There might not be, this stuff is probably always more subjective than anything else.
I think keeping the release docs in the community section as is or adding a new maintainer section are both equally good options so pick whichever you're most comfortable with.
Thanks both! @radka-j I added this guide, which I think is simple and intuitive. |