joaomcteixeira / python-project-skeleton

An up-to-date and explanatory Python project skeleton with continuous integration services.
https://python-project-skeleton.readthedocs.io
MIT License
80 stars 19 forks source link

Corrected bump2version segment in CI pipeline #32

Closed kmiller96 closed 1 year ago

kmiller96 commented 1 year ago

There is a typo where the bump performed is a minor bump, but the surrounding documentation suggests it should be a major bump.

joaomcteixeira commented 1 year ago

Could you add a summary of your additions to the CHANGELOG.rst as described here?

https://python-project-skeleton.readthedocs.io/en/latest/contributing.html#update-changelog

Otherwise, I will do :wink:

kmiller96 commented 1 year ago

You are totally right, @kmiller96. Thanks so much for your input. I hope you are finding this repository useful for your projects and learning. Best,

Hey @joaomcteixeira - was just poking around, seeing what you have in this repo to see if there is anything I can start to adopt in my personal repository template! In particular I was looking at your CI action where you bump and release package versions, hence why I managed to find this bug :)

Thank you so much for putting this together and open sourcing it! It's very helpful for both me and the community.

kmiller96 commented 1 year ago

@joaomcteixeira I have made the requested changes and have rerequested your review.

codecov-commenter commented 1 year ago

Codecov Report

Merging #32 (89036f2) into main (6f1b151) will not change coverage. The diff coverage is n/a.

:mega: This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@           Coverage Diff           @@
##             main      #32   +/-   ##
=======================================
  Coverage   93.33%   93.33%           
=======================================
  Files           4        4           
  Lines          15       15           
  Branches        1        0    -1     
=======================================
  Hits           14       14           
  Misses          1        1           

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

joaomcteixeira commented 1 year ago

Hi @kmiller96, thanks for your cheerful words. Currently, CI practices have become more popular and widespread. But, when I compiled this information, I have to say they were quite a bit obscure and not so standardized. GitHub actions themselves were not fully developed. And that was only 3 or 4 years ago.

I took the freedom to commit directly to your branch and correct your latest additions. Please see my commit. It will also serve as a tutorial. Please let me know if something is not clear in the documentation.

If the tests pass, I will merge the PR.

Many thanks for contributing.

kmiller96 commented 1 year ago

Whoops! Thanks for those corrections :)