jolly-good-toolbelt / sphinx_gherkindoc

A tool to convert Gherkin into Sphinx documentation
https://jolly-good-toolbelt.github.io/sphinx_gherkindoc/
11 stars 10 forks source link

Fix workflows: fix setup, default branch, and checkout #52

Closed dsayling closed 2 years ago

dsayling commented 2 years ago

While I was waiting for my other PR I noticed the recent move to gh actions occurred.

  1. The default branch here is still master and not main.
  2. use the poetry install to setup the environment instead of the env setup script via the bootstrap.sh
  3. fetch-depth: 0 provides a full checkout including tags.

I also removed the caching per jolly-good-toolbelt/jgt_tools/pull/44 as well

dsayling commented 2 years ago

Would you like me to fix the rest of the workflow here?

brolewis commented 2 years ago

@dsayling Sure thing. I know that https://github.com/jolly-good-toolbelt/sphinx_gherkindoc/blob/master/.github/workflows/pull-requests.yml#L32 should be run: bash bootstrap.sh but then the version checker will fail because we don't get a full clone from the checkout action, so need to figure out an option there. If you do, awesome, but if not, don't stress about that step.

dsayling commented 2 years ago

Not a problem at all. Happy to contribute.

brolewis commented 2 years ago

@dsayling You mind converting to a draft while you add changes? Don't want anyone not paying too close attention to merge while you're working :)

dgou commented 2 years ago

Will wait for exit from draft status before reviewing.

dsayling commented 2 years ago

@brolewis @dgou - ready for review

dsayling commented 2 years ago

As an aside, I'm wondering if the PR workflow should also attempt to build the docs to ensure the post merge action runs successfully.

dgou commented 2 years ago

Pulled the PR and did the triumverate of bootstrap, self-check and run-tests and that all passed.