Skip to content

Commit

Permalink
docs: project github actions
Browse files Browse the repository at this point in the history
  • Loading branch information
fyliu committed Jun 4, 2024
1 parent 56e8462 commit b046c04
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/architecture/github-actions.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit b046c04

Please sign in to comment.