Feature/mafbymaf #40
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Document package | |
on: | |
pull_request: | |
branches: | |
- develop | |
jobs: | |
update_cli_doc: | |
# The type of runner that the job will run on | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
python-version: ["3.9"] | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v3 | |
- name: Set up Python | |
uses: actions/setup-python@v3 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Document CLI and write to folder | |
run: | | |
make deps-install | |
poetry run typer postprocessing_variant_calls.main utils docs > docs/CLI.md | |
- name: Commit Doc Changes | |
run: | | |
git config --global user.name 'buehlere' | |
git config --global user.email '[email protected]' | |
PR_BRANCH=$(echo "${{ github.event.pull_request.head.ref }}") | |
git checkout origin/$PR_BRANCH | |
git pull | |
git add ./docs | |
git commit -m "Updating the repository GitHub MD documentation in the docs folder" | |
git push origin $PR_BRANCH |