Added docs on github action workflows made by OSPO

Signed-off-by: Natalia Luzuriaga <[email protected]>
DSACMS · Jan 30, 2025 · e736954 · e736954
1 parent 5f5ddce
commit e736954
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 40 deletions.
diff --git a/README.md b/README.md
@@ -138,6 +138,10 @@ cookiecutter . --directory=codejson
 
 ### Maintaining your repository using repo-scaffolder
 
+#### Updating repository using GitHub action workflows
+
+The OSPO created various [GitHub Action workflows](../docs/workflows.md) that can be used to regularly update your repository. The jobs are located in `.github` directory of your project.
+
 #### Updating projects with new repo-scaffolder upstream file changes
 
 When creating projects, if you want to receive updates then add `dsacms-tierX` as a github topic to the repo. The scaffolder repo includes github workflows that will find all repos with that tag and can raise a pull request with an updated string or adding a file. See [actions.md](https://github.com/DSACMS/repo-scaffolder/blob/main/.github/actions.md) for more information.
@@ -165,6 +169,7 @@ repolinter lint tier4/\{\{cookiecutter.project_slug\}\}
 ```
 
 #### Automated repolinter actions
+
 A tool to automatically update repositories up to hygenic standards with the use of [Repolinter through GitHub Actions](https://github.com/DSACMS/repolinter-actions) is also available. This action sends a PR to your repository with templates of all the missing files and sections that are required using a predefined rulset. Visit the repository for more information on how to get this action up and running.
 
 # Development and Software Delivery Lifecycle

diff --git a/.github/docs/workflows.md → docs/workflows.md b/.github/docs/workflows.md → docs/workflows.md
diff --git a/tier1/README.md b/tier1/README.md
@@ -7,22 +7,24 @@ A **Tier 1** project refers to an **informational or historical** project that h
 The main purpose of a Tier 1 project is to share knowledge and provide information from past work. Though available for public consumption, the project is **not expected to evolve or expand** in the future. Contributors may not engage in continuous development or issue resolution.
 
 ### Key Characteristics of a Tier 1 Project:
+
 - **Publicly released** without planned future development or maintenance.
 - Primarily **informational or historical** in nature.
 - May still provide value to the community, but it is not actively worked on.
-  
+
 ---
 
 ## Files for a Tier 1 Project
 
 There are specific files that are required and recommended to include in the repository as part of the CMS Open Source Program Office's repository hygiene guidelines and standards.
 
+| **File**          | **Requirement** | **Description**                                                                                                                                          |
+| ----------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `LICENSE`         | Mandatory       | Defines the licensing terms under which the project is distributed.                                                                                      |
+| `SECURITY.md`     | Mandatory       | Outlines the agency's security policies, including how to report security issues or vulnerabilities in the code.                                         |
+| `README.md`       | Mandatory       | Provides a comprehensive overview of the project, including its purpose, how to install or use it, and any relevant information for users or developers. |
+| `CONTRIBUTING.md` | Recommended     | Offers guidelines for contributing to the project, including code standards, how to submit issues, and creating pull requests.                           |
 
-| **File**              | **Requirement** | **Description**                                                                                             |
-|-----------------------|-----------------|-------------------------------------------------------------------------------------------------------------|
-| `LICENSE`             | Mandatory       | Defines the licensing terms under which the project is distributed. |
-| `SECURITY.md`         | Mandatory       | Outlines the agency's security policies, including how to report security issues or vulnerabilities in the code. |
-| `README.md`           | Mandatory       | Provides a comprehensive overview of the project, including its purpose, how to install or use it, and any relevant information for users or developers. |
-| `CONTRIBUTING.md`     | Recommended     | Offers guidelines for contributing to the project, including code standards, how to submit issues, and creating pull requests. |
+For more information about required sections and content within the files above, please visit [maturity-model-tiers.md](https://github.com/DSACMS/repo-scaffolder/blob/main/maturity-model-tiers.md).
 
-For more information about required sections and content within the files above, please visit [maturity-model-tiers.md](https://github.com/DSACMS/repo-scaffolder/blob/main/maturity-model-tiers.md).
+Located in the `.github` directory are [GitHub Action workflows](../docs/workflows.md) that can be used to regularly update your repository.
diff --git a/tier2/README.md b/tier2/README.md
@@ -7,6 +7,7 @@ A **Tier 2** project is a **collaborative effort** that typically occurs within
 Innersource projects often allow different teams within the same organization to contribute, fostering collaboration and code-sharing internally while maintaining control over external access.
 
 ### Key Characteristics of a Tier 2 Project:
+
 - Focuses on **collaborating within a smaller team** or internal group.
 - Utilizes **innersource practices**, where internal teams work collaboratively on code, borrowing from open source workflows but keeping the work within the organization.
 - Projects may be shared among internal stakeholders or divisions.
@@ -18,15 +19,19 @@ Innersource projects often allow different teams within the same organization to
 
 There are specific files that are required and recommended to include in the repository as part of the CMS Open Source Program Office's repository hygiene guidelines and standards.
 
-| **File**              | **Requirement** | **Description**                                                                                             |
-|-----------------------|-----------------|-------------------------------------------------------------------------------------------------------------|
-| `LICENSE`             | Mandatory       | Defines the licensing terms under which the project is distributed. |
-| `SECURITY.md`         | Mandatory       | Outlines the agency's security policies, including how to report security issues or vulnerabilities in the code. |
-| `README.md`           | Mandatory       | Provides a comprehensive overview of the project, including its purpose, how to install or use it, and any relevant information for users or developers. |
-| `CONTRIBUTING.md`     | Mandatory       | Offers guidelines for contributing to the project, including code standards, how to submit issues, and creating pull requests. |
-| `MAINTAINERS.md`      | Recommended     | Lists the individuals responsible for maintaining the project as well as reviewing and approving pull requests. |
-| `CODEOWNERS.md`       | Recommended     | Defines ownership of various sections of the repository. |
-| `COMMUNITY_GUIDELINES.md` | Mandatory   | Outlines how team members should engage with each other while working on the project, including behavior expectations for internal contributors. |
-| `CODE_OF_CONDUCT.md`  | Mandatory       | Establishes guidelines for professional and respectful behavior to foster a collaborative environment. |
+| **File**                  | **Requirement** | **Description**                                                                                                                                          |
+| ------------------------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `LICENSE`                 | Mandatory       | Defines the licensing terms under which the project is distributed.                                                                                      |
+| `SECURITY.md`             | Mandatory       | Outlines the agency's security policies, including how to report security issues or vulnerabilities in the code.                                         |
+| `README.md`               | Mandatory       | Provides a comprehensive overview of the project, including its purpose, how to install or use it, and any relevant information for users or developers. |
+| `CONTRIBUTING.md`         | Mandatory       | Offers guidelines for contributing to the project, including code standards, how to submit issues, and creating pull requests.                           |
+| `MAINTAINERS.md`          | Recommended     | Lists the individuals responsible for maintaining the project as well as reviewing and approving pull requests.                                          |
+| `CODEOWNERS.md`           | Recommended     | Defines ownership of various sections of the repository.                                                                                                 |
+| `COMMUNITY_GUIDELINES.md` | Mandatory       | Outlines how team members should engage with each other while working on the project, including behavior expectations for internal contributors.         |
+| `CODE_OF_CONDUCT.md`      | Mandatory       | Establishes guidelines for professional and respectful behavior to foster a collaborative environment.                                                   |
 
 For more information about required sections and content within the files above, please visit [maturity-model-tiers.md](https://github.com/DSACMS/repo-scaffolder/blob/main/maturity-model-tiers.md).
+
+## Workflows
+
+Located in the `.github` directory are [GitHub Action workflows](../docs/workflows.md) that can be used to regularly update your repository.
diff --git a/tier3/README.md b/tier3/README.md
@@ -5,6 +5,7 @@
 A **Tier 3** project is an **open collaboration** effort where the work is conducted in public. The project is led by smaller, semi-open teams but encourages **limited external contributions**. The work is typically **open source**, but the direction and maintenance of the project are CMS-led, controlled by a smaller group or team, rather than a large, decentralized community. Tier 3 projects may be public-facing tools, utilities, or websites, where external contributions are welcomed but managed closely by the core team.
 
 ### Key Characteristics of a Tier 3 Project:
+
 - **Collaborative in public**, where the work is open to external stakeholders.
 - Led by a **CMS team** (often organizational or tool-specific).
 - Accepts **limited contributions from external sources**, typically following specific guidelines.
@@ -17,16 +18,20 @@ A **Tier 3** project is an **open collaboration** effort where the work is condu
 
 There are specific files that are required and recommended to include in the repository as part of the CMS Open Source Program Office's repository hygiene guidelines and standards.
 
-| **File**              | **Requirement** | **Description**                                                                                             |
-|-----------------------|-----------------|-------------------------------------------------------------------------------------------------------------|
-| `LICENSE`             | Mandatory       | Defines the licensing terms under which the project is distributed. |
-| `SECURITY.md`         | Mandatory       | Outlines the agency's security policies, including how to report security issues or vulnerabilities in the code. |
-| `README.md`           | Mandatory       | Provides a comprehensive overview of the project, including its purpose, how to install or use it, and any relevant information for users or developers. |
-| `CONTRIBUTING.md`     | Mandatory       | Offers guidelines for contributing to the project, including code standards, how to submit issues, and creating pull requests. |
-| `MAINTAINERS.md`      | Recommended     | Lists the individuals responsible for maintaining the project as well as reviewing and approving pull requests. |
-| `GOVERNANCE.md`       | Recommended     | Describes the governance model of the project, such as decision-making processes and rules for contributing. It ensures a transparent process for managing the project. |
-| `CODEOWNERS.md`       | Recommended     | Defines ownership of various sections of the repository. |
-| `COMMUNITY_GUIDELINES.md` | Mandatory   | Defines expectations for interactions within the project's community, including how external contributors should engage and behave. |
-| `CODE_OF_CONDUCT.md`  | Mandatory       | Establishes guidelines for acceptable behavior within the community, setting expectations for how contributors should interact in a respectful and collaborative manner. |
+| **File**                  | **Requirement** | **Description**                                                                                                                                                          |
+| ------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `LICENSE`                 | Mandatory       | Defines the licensing terms under which the project is distributed.                                                                                                      |
+| `SECURITY.md`             | Mandatory       | Outlines the agency's security policies, including how to report security issues or vulnerabilities in the code.                                                         |
+| `README.md`               | Mandatory       | Provides a comprehensive overview of the project, including its purpose, how to install or use it, and any relevant information for users or developers.                 |
+| `CONTRIBUTING.md`         | Mandatory       | Offers guidelines for contributing to the project, including code standards, how to submit issues, and creating pull requests.                                           |
+| `MAINTAINERS.md`          | Recommended     | Lists the individuals responsible for maintaining the project as well as reviewing and approving pull requests.                                                          |
+| `GOVERNANCE.md`           | Recommended     | Describes the governance model of the project, such as decision-making processes and rules for contributing. It ensures a transparent process for managing the project.  |
+| `CODEOWNERS.md`           | Recommended     | Defines ownership of various sections of the repository.                                                                                                                 |
+| `COMMUNITY_GUIDELINES.md` | Mandatory       | Defines expectations for interactions within the project's community, including how external contributors should engage and behave.                                      |
+| `CODE_OF_CONDUCT.md`      | Mandatory       | Establishes guidelines for acceptable behavior within the community, setting expectations for how contributors should interact in a respectful and collaborative manner. |
 
 For more information about required sections and content within the files above, please visit [maturity-model-tiers.md](https://github.com/DSACMS/repo-scaffolder/blob/main/maturity-model-tiers.md).
+
+## Workflows
+
+Located in the `.github` directory are [GitHub Action workflows](../docs/workflows.md) that can be used to regularly update your repository.