Skip to content

Commit

Permalink
Merge pull request #221 from DSACMS/nat/docs
Browse files Browse the repository at this point in the history
Docs: Created documentation for GH action workflows
  • Loading branch information
natalialuzuriaga authored Jan 13, 2025
2 parents dd7fa6a + 3e5a500 commit 74c4256
Show file tree
Hide file tree
Showing 3 changed files with 286 additions and 258 deletions.
11 changes: 11 additions & 0 deletions .github/docs/workflows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Workflows

Located in .**github/workflows**, the OSPO has created GitHub Actions workflows to assist project teams with development and documentation upkeep for repository hygiene.

| File Name | Tier | Description |
| :--------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------- | :------------------------------------------------- |
| [auto-changelog.yml](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/auto-changelog.yml) | 2, 3, 4 | Auto-generates a CHANGELOG.md |
| [checks.yml](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/checks.yml) | 1, 2, 3, 4 | Performs repolinter checks |
| [contributors.yml](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/contributors.yml) | 2, 3, 4 | Generates a list of contributors in MAINTAINERS.md |
| [gitleaks.yml](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/gitleaks.yml) | 1, 2, 3, 4 | Scans for secrets upon each push or PR |
| [repoStructure.yml](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/repoStructure.yml) | 3, 4 | Generates repo structure in README.md |
10 changes: 7 additions & 3 deletions tier1/{{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,23 @@
{{ cookiecutter.project_description }}

## About the Project
<!-- This should be a longer-form description of the project. It can include history, background, details, problem statements, links to design documents or other supporting materials, or any other information/context that a user or contributor might be interested in. -->
**{project statement}**

<!--
### Project Mission
**{project mission}** -->
**{project mission}**
Provide the core mission and objectives driving this project.-->

<!--
### Agency Mission
TODO: Recommended to include since this is an agency-led project -->
TODO: Recommended to include since this is an agency-led project
Provide the mission of the agency and how this project aligns. -->

<!--
### Team Mission
TODO: Recommended to include since this is an agency-led project -->
TODO: Recommended to include since this is an agency-led project
Provide the team's mission and how they work together. -->

## Core Team

Expand Down
Loading

0 comments on commit 74c4256

Please sign in to comment.