diff --git a/code.json b/code.json new file mode 100644 index 0000000..8037303 --- /dev/null +++ b/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" +} \ No newline at end of file diff --git a/tier0/{{cookiecutter.project_slug}}/README.md b/tier0/{{cookiecutter.project_slug}}/README.md index 0b202cc..3993636 100644 --- a/tier0/{{cookiecutter.project_slug}}/README.md +++ b/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. --> diff --git a/tier1/checklist.pdf b/tier1/checklist.pdf index 0ce502c..4c91664 100644 Binary files a/tier1/checklist.pdf and b/tier1/checklist.pdf differ diff --git a/tier1/{{cookiecutter.project_slug}}/.github/workflows/checks.yml b/tier1/{{cookiecutter.project_slug}}/.github/workflows/checks.yml index 3dcccde..2a564d0 100644 --- a/tier1/{{cookiecutter.project_slug}}/.github/workflows/checks.yml +++ b/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 diff --git a/tier1/{{cookiecutter.project_slug}}/README.md b/tier1/{{cookiecutter.project_slug}}/README.md index 81be898..3299893 100644 --- a/tier1/{{cookiecutter.project_slug}}/README.md +++ b/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 diff --git a/tier2/checklist.pdf b/tier2/checklist.pdf index 208cffc..bbd78e5 100644 Binary files a/tier2/checklist.pdf and b/tier2/checklist.pdf differ diff --git a/tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md index 88e6c39..07463f4 100644 --- a/tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/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 - ## Local Development @@ -52,7 +52,7 @@ This project is monorepo with several apps. Please see the [api](./api/README.md -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. diff --git a/tier3/checklist.pdf b/tier3/checklist.pdf index b4461fa..ad44d4f 100644 Binary files a/tier3/checklist.pdf and b/tier3/checklist.pdf differ diff --git a/tier3/{{cookiecutter.project_slug}}/.github/workflows/repoStructure.yml b/tier3/{{cookiecutter.project_slug}}/.github/workflows/repoStructure.yml new file mode 100644 index 0000000..78e4e17 --- /dev/null +++ b/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//\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 diff --git a/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md index d9d518e..49ce9b5 100644 --- a/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/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 - This project is governed by our [Community Guidelines](COMMUNITY_GUIDELINES.md) and [Code of Conduct](CODE_OF_CONDUCT.md). diff --git a/tier3/{{cookiecutter.project_slug}}/MAINTAINERS.md b/tier3/{{cookiecutter.project_slug}}/MAINTAINERS.md index 8f97204..db8132d 100644 --- a/tier3/{{cookiecutter.project_slug}}/MAINTAINERS.md +++ b/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 diff --git a/tier3/{{cookiecutter.project_slug}}/README.md b/tier3/{{cookiecutter.project_slug}}/README.md index 78f7c42..79ae938 100644 --- a/tier3/{{cookiecutter.project_slug}}/README.md +++ b/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 + **{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 -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. --> diff --git a/tier4/checklist.pdf b/tier4/checklist.pdf index 012707f..4597099 100644 Binary files a/tier4/checklist.pdf and b/tier4/checklist.pdf differ diff --git a/tier4/{{cookiecutter.project_slug}}/.github/workflows/repoStructure.yml b/tier4/{{cookiecutter.project_slug}}/.github/workflows/repoStructure.yml new file mode 100644 index 0000000..78e4e17 --- /dev/null +++ b/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//\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 diff --git a/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md index 9fececf..a18a4ef 100644 --- a/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/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 - This project is governed by our [Community Guidelines](COMMUNITY_GUIDELINES.md) and [Code of Conduct](CODE_OF_CONDUCT.md). diff --git a/tier4/{{cookiecutter.project_slug}}/MAINTAINERS.md b/tier4/{{cookiecutter.project_slug}}/MAINTAINERS.md index 8f97204..db8132d 100644 --- a/tier4/{{cookiecutter.project_slug}}/MAINTAINERS.md +++ b/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 diff --git a/tier4/{{cookiecutter.project_slug}}/README.md b/tier4/{{cookiecutter.project_slug}}/README.md index e192726..cb2e961 100644 --- a/tier4/{{cookiecutter.project_slug}}/README.md +++ b/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 + **{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. -->