Python Poetry CI/CD

Python Poetry package with basic CI/CD using GitHub actions

Usage

• Make new repo with this template
• Add PERSONAL_ACCESS_TOKEN and PYPI_TOKEN secrets
• Clone your new repo
• [optional] Install recommended VScode extensions
• Install dependencies and update python interpreter path

make deps

• Create a new branch to start development

git branch <branch_name>
git checkout <branch_name>

• Replace all occurances of label_your_data_api with the name of your package
  • pyproject.toml
  • .github/workflows/deploy.yml
  • label_your_data_api/__main__py
  • label_your_data_api - directory
  • (tip) In VScode use Ctrl+Shift+F
• Check the tests are passing before commiting

poetry run pytest

• Commit your changes usig the conventional commits format
  • (tip) use the VScode Conventional Commits extension to help

git add .
make czc

• If commit type follows semantic version changes, manually bump the version

cz bump

• Push your changes to GitHub

git push && git push --tags

• Go to your newly created branch on GitHub and create pull request
• Wait for checks to pass from the CI workflow
• Merge pull request after all the checks have passed
• Now back on the main branch more workflows should start
• Wait for all the workflows to finish and go to /releases
• Review the release draft and publish when ready