InstituteforDiseaseModeling / cookiecutter-python-library

0 stars 3 forks source link

Add github actions workflows for bumpversion, build/test, and publish. #11

Closed ChJones-IDM closed 3 years ago

ChJones-IDM commented 3 years ago

See README.md for description of the workflows.

The package doesn't seem to build correctly currently, not sure if that's just a templating thing, I didn't look into it too much.

Also, I'm not sure what the overall scheme with regard to versioning / bump version config is desired, I tried to make the system as flexible as possible but I'm not sure what the exact use case is so I don't know if it's workable or needs changes.

CWiswell-IDM commented 3 years ago

For clarity, when this is structured the right way, we should expect a file layout in this repo like so:

/hooks /{{ cookiecutter.library.name }} /{{ cookiecutter.library.name }}/build-install-package-workflow/lots_of_files /{{ cookiecutter.library.name }}/.github .gitignore README.md cookiecutter.json

Then anyone creating a project from cookiecutter can get the build-test-workflow stuff into their project for free (or the cost of answering a handful of questions when answering the questions that cookiecutter asks of them)

CWiswell-IDM commented 3 years ago

@devclinton is there someone on your team who could spin up a repo to test this once @ChJones-IDM has his stuff in the right place?

  1. Spin up repo from this cookiecutter project
  2. See that the build-install-package-workflow with a couple of unit tests that pass and see if a built package makes its way into staging artifactory
  3. Check something in that breaks a test and see if the workflow fails like it should (old package is still latest in artifactory) Then archive / delete the project once we've got things working