Merge pull request #129 from DSACMS/dev

Merge Dev Into Main

code.json

@@ -0,0 +1,10 @@
+{
+    "project_type": "Tools",
+    "user_input": "No",
+    "project_fisma_level": "Low",
+    "group": "CMS/OA/DSAC",
+    "subset_in_healthcare": "Operational",
+    "user_type": "Government",
+    "repository_host": "Github.com",
+    "maturity_model_tier": "3"
+}

tier0/{{cookiecutter.project_slug}}/README.md

@@ -76,7 +76,7 @@ TODO: Using the "tree -d" command can be a helpful way to generate this informat
 
 TODO - Add the repo's linting and code style guidelines
 
-Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before commiting.
+Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before committing.
 -->
 
 <!--
@@ -91,7 +91,7 @@ This project follows [trunk-based development](https://trunkbaseddevelopment.com
 * Ticket any unfinished or partially finished work.
 * Tests should be written for changes introduced, and adhere to the text percentage threshold determined by the project.
 
-This project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/worfklows](.github/workflows) directory.
+This project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/workflows](.github/workflows) directory.
 
 Pull-requests are merged to `main` and the changes are immediately deployed to the development environment. Releases are created to push changes to production.
 -->

tier1/{{cookiecutter.project_slug}}/.github/workflows/checks.yml

@@ -15,7 +15,9 @@ jobs:
     needs: resolve-repolinter-json
     runs-on: ubuntu-latest
     env:
+      {% raw %}
       RAW_JSON: ${{ needs.resolve-repolinter-json.outputs.raw-json}}
+      {% endraw %}
     steps:
       - uses: actions/checkout@v4
       - run: echo $RAW_JSON > repolinter.json

tier1/{{cookiecutter.project_slug}}/README.md

@@ -38,7 +38,7 @@ TODO: Using the "tree -d" command can be a helpful way to generate this informat
 
 <!--
 # Development and Software Delivery Lifecycle
-The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that externabl contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contribributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md).
+The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md).
 -->
 
 <!--
@@ -53,7 +53,7 @@ This project is monorepo with several apps. Please see the [api](./api/README.md
 
 TODO - Add the repo's linting and code style guidelines
 
-Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before commiting.
+Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before committing.
 -->
 
 <!--
@@ -68,7 +68,7 @@ This project follows [trunk-based development](https://trunkbaseddevelopment.com
 * Ticket any unfinished or partially finished work.
 * Tests should be written for changes introduced, and adhere to the text percentage threshold determined by the project.
 
-This project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/worfklows](.github/workflows) directory.
+This project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/workflows](.github/workflows) directory.
 
 Pull-requests are merged to `main` and the changes are immediately deployed to the development environment. Releases are created to push changes to production.
 -->

tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md

@@ -55,7 +55,7 @@ TODO: Discuss where tests can be found, how they are run, and what kind of tests
 
 ### Coding Style and Linters
 
-<!--- TODO: HIGHLY ENCOURAGED. Specific tools will vary between different languages/frameworks (e.g. Black for python, esliint for JavaScript, etc...)
+<!--- TODO: HIGHLY ENCOURAGED. Specific tools will vary between different languages/frameworks (e.g. Black for python, eslint for JavaScript, etc...)
 
 1. Mention any style guides you adhere to (e.g. pep8, etc...)
 2. Mention any linters your project uses (e.g. flake8, jslint, etc...) 

tier2/{{cookiecutter.project_slug}}/README.md

@@ -39,7 +39,7 @@ TODO: Using the "tree -d" command can be a helpful way to generate this informat
 
 <!-- 
 # Development and Software Delivery Lifecycle 
-The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that externabl contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contribributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md).
+The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md).
 -->
 
 ## Local Development
@@ -52,7 +52,7 @@ This project is monorepo with several apps. Please see the [api](./api/README.md
 
 <!-- TODO - Add the repo's linting and code style guidelines -->
 
-Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before commiting.
+Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before committing.
 
 <!--
 ## Branching Model
@@ -66,7 +66,7 @@ This project follows [trunk-based development](https://trunkbaseddevelopment.com
 * Ticket any unfinished or partially finished work.
 * Tests should be written for changes introduced, and adhere to the text percentage threshold determined by the project.
 
-This project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/worfklows](.github/workflows) directory.
+This project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/workflows](.github/workflows) directory.
 
 Pull-requests are merged to `main` and the changes are immediately deployed to the development environment. Releases are created to push changes to production.
 -->

tier3/{{cookiecutter.project_slug}}/.github/workflows/repoStructure.yml

@@ -0,0 +1,37 @@
+on:
+    push:
+        branches:
+            - main
+    workflow_dispatch:
+
+jobs:
+    populate-repo-structure:
+        runs-on: ubuntu-latest
+        name: Update repo structure in README.md
+        permissions:
+            contents: write
+            pull-requests: write
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Populate repository structure with tree command
+              # https://stackoverflow.com/questions/29613304/is-it-possible-to-escape-regex-metacharacters-reliably-with-sed
+              # https://stackoverflow.com/questions/407523/escape-a-string-for-a-sed-replace-pattern
+              run: |
+                  quoteSubst() {
+                    IFS= read -d '' -r < <(sed -e ':a' -e '$!{N;ba' -e '}' -e 's/[&/\]/\\&/g; s/\n/\\&/g' <<<"$1")
+                    printf %s "${REPLY%$'\n'}"
+                  }
+                  TREE_OUTPUT=$(tree -d)
+                  sed -i 's/<!--TREE START--><!--TREE END-->/\n```plaintext\n'"$(quoteSubst $TREE_OUTPUT)"'\n```\n/g' README.md
+
+            - name: Commit and push changes
+              # https://github.com/orgs/community/discussions/26560#discussioncomment-3531273
+              # commit changes, but if no changes exist, then exit cleanly
+              run: |
+                  git config user.name 'github-actions[bot]'
+                  git config user.email 'github-actions[bot]@users.noreply.github.com'
+                  git add README.md
+                  git commit -m "BOT: Update repo structure in README.md" || exit 0
+                  git push

tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md

@@ -50,7 +50,7 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow
 
 ### Coding Style and Linters
 
-<!--- TODO: HIGHLY ENCOURAGED. Specific tools will vary between different languages/frameworks (e.g. Black for python, esliint for JavaScript, etc...)
+<!--- TODO: HIGHLY ENCOURAGED. Specific tools will vary between different languages/frameworks (e.g. Black for python, eslint for JavaScript, etc...)
 
 1. Mention any style guides you adhere to (e.g. pep8, etc...)
 2. Mention any linters your project uses (e.g. flake8, jslint, etc...)

tier3/{{cookiecutter.project_slug}}/GOVERNANCE.md

@@ -1,5 +1,5 @@
 # Governance
-<!-- TODO: Starting at Tier 3 GOVERNANCE.md has basic language about early community governance, how the project make decisions, and how contirbutors are elevated through the leadership process if any (e.g. joining teams, getting maintainer status, etc...)
+<!-- TODO: Starting at Tier 3 GOVERNANCE.md has basic language about early community governance, how the project make decisions, and how contributors are elevated through the leadership process if any (e.g. joining teams, getting maintainer status, etc...)
 -->
 
 This project is governed by our [Community Guidelines](COMMUNITY_GUIDELINES.md) and [Code of Conduct](CODE_OF_CONDUCT.md). 

tier3/{{cookiecutter.project_slug}}/MAINTAINERS.md

@@ -15,9 +15,9 @@ This is a list of maintainers for this project. See [CODEOWNERS.md](./CODEOWNERS
 | Roles        | Responsibilities| Requirements  | Defined by|
 | -------------|:---------------|:-------------|:-------------|
 | member       | active contributor in the community | multiple contributions to the project. | PROJECT GitHub org Committer Team|
-| reviewer     | review contributions from other members | history of review and authorship in a subproject | MAINTAINERS file reviewer entry, and GitHub Org Triage Team|
-| approver     | approve accepting contributions | highly experienced and active reviewer + contributor to a subproject  | MAINTAINERS file approver entry and GitHub Triage Team |
-| lead         | set direction and priorities for a subproject | demonstrated responsibility and excellent technical judgement for the subproject |  MAINTAINERS file owner entry and GitHub Org Admin Team|
+| reviewer     | review contributions from other members | history of review and authorship in a sub-project | MAINTAINERS file reviewer entry, and GitHub Org Triage Team|
+| approver     | approve accepting contributions | highly experienced and active reviewer + contributor to a sub-project  | MAINTAINERS file approver entry and GitHub Triage Team |
+| lead         | set direction and priorities for a sub-project | demonstrated responsibility and excellent technical judgement for the sub-project |  MAINTAINERS file owner entry and GitHub Org Admin Team|
 
 ## Contributors
 

tier3/{{cookiecutter.project_slug}}/README.md

@@ -33,12 +33,13 @@ An up-to-date list of core team members can be found in [MAINTAINERS.md](MAINTAI
 ## Repository Structure
 
 <!-- TODO: Using the "tree -d" command can be a helpful way to generate this information, but, be sure to update it as the project evolves and changes over time.-->
+<!--TREE START--><!--TREE END-->
 
 **{list directories and descriptions}**
 
 # Development and Software Delivery Lifecycle 
 
-The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contribributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md).
+The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md).
 
 ## Local Development
 
@@ -50,7 +51,7 @@ This project is monorepo with several apps. Please see the [api](./api/README.md
 
 <!-- TODO - Add the repo's linting and code style guidelines -->
 
-Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before commiting.
+Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before committing.
 
 ## Branching Model
 
@@ -63,7 +64,7 @@ This project follows [trunk-based development](https://trunkbaseddevelopment.com
 * Ticket any unfinished or partially finished work.
 * Tests should be written for changes introduced, and adhere to the text percentage threshold determined by the project.
 
-This project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/worfklows](.github/workflows) directory.
+This project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/workflows](.github/workflows) directory.
 
 Pull-requests are merged to `main` and the changes are immediately deployed to the development environment. Releases are created to push changes to production.
 -->

tier4/{{cookiecutter.project_slug}}/.github/workflows/repoStructure.yml

@@ -0,0 +1,37 @@
+on:
+    push:
+        branches:
+            - main
+    workflow_dispatch:
+
+jobs:
+    populate-repo-structure:
+        runs-on: ubuntu-latest
+        name: Update repo structure in README.md
+        permissions:
+            contents: write
+            pull-requests: write
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Populate repository structure with tree command
+              # https://stackoverflow.com/questions/29613304/is-it-possible-to-escape-regex-metacharacters-reliably-with-sed
+              # https://stackoverflow.com/questions/407523/escape-a-string-for-a-sed-replace-pattern
+              run: |
+                  quoteSubst() {
+                    IFS= read -d '' -r < <(sed -e ':a' -e '$!{N;ba' -e '}' -e 's/[&/\]/\\&/g; s/\n/\\&/g' <<<"$1")
+                    printf %s "${REPLY%$'\n'}"
+                  }
+                  TREE_OUTPUT=$(tree -d)
+                  sed -i 's/<!--TREE START--><!--TREE END-->/\n```plaintext\n'"$(quoteSubst $TREE_OUTPUT)"'\n```\n/g' README.md
+
+            - name: Commit and push changes
+              # https://github.com/orgs/community/discussions/26560#discussioncomment-3531273
+              # commit changes, but if no changes exist, then exit cleanly
+              run: |
+                  git config user.name 'github-actions[bot]'
+                  git config user.email 'github-actions[bot]@users.noreply.github.com'
+                  git add README.md
+                  git commit -m "BOT: Update repo structure in README.md" || exit 0
+                  git push

tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md

@@ -50,7 +50,7 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow
 
 ### Coding Style and Linters
 
-<!--- TODO: HIGHLY ENCOURAGED. Specific tools will vary between different languages/frameworks (e.g. Black for python, esliint for JavaScript, etc...)
+<!--- TODO: HIGHLY ENCOURAGED. Specific tools will vary between different languages/frameworks (e.g. Black for python, eslint for JavaScript, etc...)
 
 1. Mention any style guides you adhere to (e.g. pep8, etc...)
 2. Mention any linters your project uses (e.g. flake8, jslint, etc...)

tier4/{{cookiecutter.project_slug}}/GOVERNANCE.md

@@ -1,5 +1,5 @@
 # Governance
-<!-- TODO: Starting at Tier 3 GOVERNANCE.md has basic language about early community governance, how the project make decisions, and how contirbutors are elevated through the leadership process if any (e.g. joining teams, getting maintainer status, etc...)
+<!-- TODO: Starting at Tier 3 GOVERNANCE.md has basic language about early community governance, how the project make decisions, and how contributors are elevated through the leadership process if any (e.g. joining teams, getting maintainer status, etc...)
 -->
 
 This project is governed by our [Community Guidelines](COMMUNITY_GUIDELINES.md) and [Code of Conduct](CODE_OF_CONDUCT.md). 

tier4/{{cookiecutter.project_slug}}/MAINTAINERS.md

@@ -15,9 +15,9 @@ This is a list of maintainers for this project. See [CODEOWNERS.md](./CODEOWNERS
 | Roles        | Responsibilities| Requirements  | Defined by|
 | -------------|:---------------|:-------------|:-------------|
 | member       | active contributor in the community | multiple contributions to the project. | PROJECT GitHub org Committer Team|
-| reviewer     | review contributions from other members | history of review and authorship in a subproject | MAINTAINERS file reviewer entry, and GitHub Org Triage Team|
-| approver     | approve accepting contributions | highly experienced and active reviewer + contributor to a subproject  | MAINTAINERS file approver entry and GitHub Triage Team |
-| lead         | set direction and priorities for a subproject | demonstrated responsibility and excellent technical judgement for the subproject |  MAINTAINERS file owner entry and GitHub Org Admin Team|
+| reviewer     | review contributions from other members | history of review and authorship in a sub-project | MAINTAINERS file reviewer entry, and GitHub Org Triage Team|
+| approver     | approve accepting contributions | highly experienced and active reviewer + contributor to a sub-project  | MAINTAINERS file approver entry and GitHub Triage Team |
+| lead         | set direction and priorities for a sub-project | demonstrated responsibility and excellent technical judgement for the sub-project |  MAINTAINERS file owner entry and GitHub Org Admin Team|
 
 ## Contributors
 

tier4/{{cookiecutter.project_slug}}/README.md

@@ -25,12 +25,13 @@ An up-to-date list of core team members can be found in [MAINTAINERS.md](MAINTAI
 ## Repository Structure
 
 <!-- TODO: Using the "tree -d" command can be a helpful way to generate this information, but, be sure to update it as the project evolves and changes over time. -->
+<!--TREE START--><!--TREE END-->
 
 **{list directories and descriptions}**
 
 # Development and Software Delivery Lifecycle 
 
-The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contribributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md).
+The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md).
 
 ## Local Development
 
@@ -54,7 +55,7 @@ This project follows [trunk-based development](https://trunkbaseddevelopment.com
 * Ticket any unfinished or partially finished work.
 * Tests should be written for changes introduced, and adhere to the text percentage threshold determined by the project.
 
-This project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/worfklows](.github/workflows) directory.
+This project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/workflows](.github/workflows) directory.
 
 Pull-requests are merged to `main` and the changes are immediately deployed to the development environment. Releases are created to push changes to production.
 -->