diff --git a/docs/workflows/.pages b/docs/workflows/.pages deleted file mode 100644 index 02d93f29..00000000 --- a/docs/workflows/.pages +++ /dev/null @@ -1 +0,0 @@ -title: "Workflows" diff --git a/docs/workflows/ci_check_pyproject_dependencies.md b/docs/workflows/ci_check_pyproject_dependencies.md index b961a06d..e2f6d9bd 100644 --- a/docs/workflows/ci_check_pyproject_dependencies.md +++ b/docs/workflows/ci_check_pyproject_dependencies.md @@ -8,8 +8,9 @@ This workflow runs an [Invoke](https://pyinvoke.org) task to check dependencies The reason for having this workflow and not using [Dependabot](https://github.com/dependabot/dependabot-core) is because it seems to not function properly with this use case. -> **Warning**: If a PAT is not passed through for the `PAT` secret and `GITHUB_TOKEN` is used, beware that any other CI/CD jobs that run for, e.g., pull request events, may not run since `GITHUB_TOKEN`-generated PRs are designed to not start more workflows to avoid escalation. -> Hence, if it is important to run CI/CD workflows for pull requests, consider passing a PAT as a secret to this workflow represented by the `PAT` secret. +!!! warning + If a PAT is not passed through for the `PAT` secret and `GITHUB_TOKEN` is used, beware that any other CI/CD jobs that run for, e.g., pull request events, may not run since `GITHUB_TOKEN`-generated PRs are designed to not start more workflows to avoid escalation. + Hence, if it is important to run CI/CD workflows for pull requests, consider passing a PAT as a secret to this workflow represented by the `PAT` secret. ## Expectations diff --git a/docs/workflows/index.md b/docs/workflows/index.md new file mode 100644 index 00000000..f57ccfd4 --- /dev/null +++ b/docs/workflows/index.md @@ -0,0 +1,9 @@ +# Workflows + +This section contains all the available callable/reusable workflows: + +- [CD - Release (`cd_release.yml`)](./cd_release.md) +- [CI - Activate auto-merging for PRs (`ci_automerge_prs.yml`)](./ci_automerge_prs.md) +- [CI/CD - New updates to default branch (`ci_cd_updated_default_branch.yml`))](./ci_cd_updated_default_branch.md) +- [CI - Check dependencies (`ci_check_pyproject_dependencies.yml`)](./ci_check_pyproject_dependencies.md) +- [CI - Update dependencies (`ci_update_dependencies.yml`)](./ci_update_dependencies.md) diff --git a/mkdocs.yml b/mkdocs.yml index 139200e6..d92c4d46 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -73,7 +73,9 @@ plugins: nav: - Home: index.md - - ... | workflows/** + - Workflows: + - Overview: workflows/index.md + - ... | flat - ... | python/** - License: LICENSE.md - Changelog: CHANGELOG.md