diff --git a/docs/architecture/github_actions.md b/docs/architecture/github_actions.md new file mode 100644 index 00000000..4cbbe442 --- /dev/null +++ b/docs/architecture/github_actions.md @@ -0,0 +1,29 @@ +# Github actions + +These are the github actions used in the project. + +## Files + +```bash +.github/workflows/ +├── deploy-docs.yml # (1)! +└── new-issue-create-card.yml # (2)! +``` + +1. Deploy Documentation + - triggered by commits to `main` + - builds and deploys the mkdocs documentation to github pages. +1. Create card for new issues + - triggerd by new issue creation + - creates cards for new issues in the project board. + - no longer relevant after the project board migration, since the new project provides this automation. + +## Actions page workflows + +1. Create card for new issues + - see new-issue-create-card.yml above +1. deploy-docs + - see deploy-docs.yml above +1. pages-build-deployment + - The github-pages bot runs this automatically for any project that publishes to github pages. + - It does extra work that we don't need, but there's no way to disable it. See [here](https://stackoverflow.com/questions/72079903/do-i-need-the-pages-build-deployment-github-action-when-i-have-another-action-f).