generated from hackforla/.github-hackforla-base-repo-template
-
-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
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
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). |