initial commit

Author: natalialuzuriaga

.github/codejson/hooks/post_gen_project.py

@@ -0,0 +1,132 @@
+import subprocess
+import shutil
+import json
+import os
+import shutil
+
+def get_date_fields():
+    # Run git commands and capture as string
+    output = subprocess.run(['git', 'log', '--date=iso', '--pretty=%cI', '--max-parents=0', '-n', '1'], capture_output=True, text=True)
+
+    # Store string and strip of leading / trailing whitespace
+    date =  output.stdout.strip()
+
+    # Create a dictionary for date information to be pushed to JSON
+    date_information = {"created": f"{date}", 
+    "lastModified": "{% now 'utc', '%Y-%m-%dT%H:%M:%S%z' %}",
+    "metadataLastUpdated": "{% now 'utc', '%Y-%m-%dT%H:%M:%S%z' %}"}
+
+    return date_information
+
+def get_scc_labor_hours():
+    if shutil.which('scc') is not None:
+        try:
+            #Run scc and load results into a dictionary
+            #assuming we are in the .git directory of the repo
+            cmd = ['scc', '..', '--format', 'json2', '--exclude-file']
+
+            # Currently only supports specific files
+            files_to_exclude = [
+                "checks.yml,auto-changelog.yml,contributors.yml,repoStructure.yml,code.json,checklist.md,checklist.pdf,README.md,CONTIRBUTING.md,LICENSE,MAINTAINERS.md,repolinter.json,SECURITY.md,CODE_OF_CONDUCT.md,CODEOWNERS.md,COMMUNITY_GUIDELINES.md,GOVERANCE.md"
+            ]
+
+            cmd.extend(files_to_exclude)
+
+            d = json.loads(subprocess.run(cmd,check=True, capture_output=True).stdout)
+            
+            l_hours = d['estimatedScheduleMonths'] * 730.001
+
+            return round(l_hours,2)
+            
+        except (subprocess.CalledProcessError, KeyError) as e:
+            print(e)
+            return None
+    else:
+        print("scc (https://github.com/boyter/scc) not found on system")
+
+        #Otherwise just use previous value as a default value.
+        return None
+
+def prompt_exemption_text(exemptionType):
+    print(f"You have selected {exemptionType} for your Usage Type.")
+    return input("Please provide a one or two sentence justification for the exemption used: ")
+
+def format_multi_select_fields(text):
+    new_text = text.split(",")
+
+    new_text = [text.strip() for text in new_text]
+
+    return new_text
+
+def update_code_json(json_file_path):
+    # Read the JSON 
+    with open(json_file_path, 'r') as file:
+        data = json.load(file)
+
+    # Add date_information and labor hours to the JSON
+    data['date'] = get_date_fields()
+
+    # Calculate labor hours
+    hours = get_scc_labor_hours()
+    if hours:
+        data['laborHours'] = hours
+    else:
+        data['laborHours'] = None
+
+    # Check if usageType is an exemption
+    if data['permissions']['usageType'].startswith('exempt'):
+        exemption_text = prompt_exemption_text(data['permissions']['usageType'])
+        data['permissions']['exemptionText'] = exemption_text
+    else:
+        del data['permissions']['exemptionText']
+
+    # Format multi-select options
+    data['categories'] = format_multi_select_fields(data['categories'][0])
+    data['languages'] = format_multi_select_fields(data['languages'][0])
+    data['tags'] = format_multi_select_fields(data['tags'][0])
+
+    # Update the JSON 
+    with open(json_file_path, 'w') as file:
+        json.dump(data, file, indent = 2)
+
+def main():
+    try:
+        # Change to the parent directory
+        os.chdir('..')
+
+        # Define the codejson directory to remove
+        dir_name = "codejson"
+
+        # Check if codejson directory exists and remove it
+        if os.path.exists(dir_name):
+            shutil.rmtree(dir_name)
+
+        # Get the project name from cookiecutter
+        sub_project_dir = "{{cookiecutter.project_name}}"
+        codejson_file = "code.json"
+        project_root_dir = os.path.abspath('..')
+
+        json_file_path = os.path.join(sub_project_dir, codejson_file)
+    
+        if os.path.exists(json_file_path):
+            # Move code.json file to parent directory
+            new_json_path = os.path.join(project_root_dir, codejson_file)
+            shutil.move(json_file_path, new_json_path)
+        
+            # Remove the source directory
+            shutil.rmtree(sub_project_dir)
+
+            # Update the json with date and scc information
+            update_code_json(new_json_path)
+            print("Succesfully generated code.json file!")
+
+        else:
+            print(f"Error: {codejson_file} not found in {sub_project_dir}")
+
+    except OSError as error:
+        print(f"Error during OS operations: {error}")
+    except shutil.Error as error:
+        print(f"Error during shutil operations: {error}")
+
+if __name__ == "__main__":
+    main()

.github/codejson/{{cookiecutter.project_name}}/code.json

@@ -0,0 +1,44 @@
+{
+  "name": "{{ cookiecutter.project_name }}",
+  "description": {
+    "en": {
+      "shortDescription": "{{ cookiecutter.short_description }}",
+      "longDescription": "{{ cookiecutter.long_description }}"
+    }
+  },
+  "status": "{{ cookiecutter.status }}",
+  "permissions": {
+    "licenses": [
+      {
+        "URL": "LICENSE",
+        "name": "{{ cookiecutter.license }}"
+      }
+    ],
+    "usageType": "{{ cookiecutter.usage_type }}",
+    "exemptionText": ""
+  },
+  "organization": "Centers for Medicare & Medicaid Services",
+  "repositoryURL": "https://github.com/{{ cookiecutter.project_org }}/{{ cookiecutter.project_name }}",
+  "vcs": "{{ cookiecutter.vcs }}",
+  "laborHours": [""],
+  "platforms": [ "{{ cookiecutter.platforms }}" ],
+  "categories": [ "{{ cookiecutter.categories }}" ],
+  "softwareType": "{{ cookiecutter.software_type }}",
+  "languages": [ "{{ cookiecutter.languages }}" ],
+  "maintenance": "{{ cookiecutter.maintenance }}",
+  "date": [""],
+  "tags": [ "{{ cookiecutter.tags }}" ],
+  "contact": {
+    "email": "{{ cookiecutter.contact_email }}",
+    "name": "{{ cookiecutter.contact_name }}"
+  },
+  "localisation": "{{ cookiecutter.localisation }}",
+  "repoType": "{{ cookiecutter.repo_type }}",
+  "userInput": "{{ cookiecutter.user_input }}",
+  "fismaLevel": "{{ cookiecutter.fisma_level }}",
+  "group": "{{ cookiecutter.group }}",
+  "subsetInHealthcare": "{{ cookiecutter.subset_in_healthcare }}",
+  "userType": "{{ cookiecutter.user_type }}",
+  "repositoryHost": "{{ cookiecutter.repository_host }}",
+  "maturityModelTier": "1"
+}

.github/cookiecutter.json

@@ -0,0 +1,52 @@
+{
+    "project_name": "codejson-generator", 
+    "project_org": "DSACMS", 
+    "short_description": "A short description of the project.",
+    "long_description": "A longer description of the project.",
+    "subset_in_healthcare": "Policy, Operational",
+    "user_type": "Providers, Patients, Government",
+    "user_input": ["Yes", "No"],
+    "group": "CMS/OA/DSAC",
+    "repository_host": ["Github.com", "GitHub ENT", "GitHub Cloud", "GitLab.com", "GitLab ENT", "GitLab ENT CCSQ"],
+    "status": ["ideation", "development", "alpha", "beta", "release candidate", "production", "archival"],
+    "fisma_level": ["Low", "Moderate", "High"],
+    "license": ["CC0-1.0", "Apache-2.0", "MIT", "MPL-2.0", "GPL-2.0-only", "GPL-3.0-only", "GPL-3.0-or-later", "LGPL-2.1-only", "LGPL-3.0-only", "BSD-2-Clause", "BSD-3-Clause", "EPL-2.0", "Other"],
+    "vcs": ["git", "hg", "svn", "rcs", "bzr"],
+    "platforms": ["web", "windows", "mac", "linux", "ios", "android", "other"],
+    "categories": "healthcare",
+    "software_type":["standalone/mobile", "standalone/iot", "standalone/desktop", "standalone/web", "standalone/backend", "standalone/other", "addon", "library", "configurationFiles"],
+    "languages": "None",
+    "repo_type" : ["Package", "Website", "Standards", "Libraries", "Data", "Apps", "Tools", "APIs", "Docs"],
+    "usage_type" : ["openSource", "governmentWideReuse", "exemptByLaw", "exemptByNationalSecurity", "exemptByAgencySystem", "exemptByAgencyMission", "exemptByCIO", "exemptByPolicyDate"],
+    "maintenance": ["internal", "contract", "community", "none"],
+    "tags": "healthcare",
+    "contact_email": "opensource@cms.hhs.gov",
+    "contact_name": "CMS Open Source Program Office",
+    "localisation": ["true", "false"],
+    "__prompts__": {
+        "project_name": "Project name:",
+        "project_org": "GitHub organization:",
+        "short_description": "Provide a short description of the software. It should be a single line containing a single sentence. Maximum 150 characters are allowed.",
+        "long_description": "Provide longer description of the software, between 150 and 10000 chars. It is meant to provide an overview of the capabilities of the software for a potential user.",
+        "subset_in_healthcare": "Which subset of healthcare does the project belong to?",
+        "user_type": "Who are the intended users?",
+        "user_input": "Does the project accept user input? (e.g. allows user to query a database, allows login by users, upload files, etc.)",
+        "group": "Which group at CMS is the project part of?",
+        "repository_host": "Where is the repository hosted?",
+        "status": "What is the status of the project?",
+        "fisma_level": "What FISMA level is this project classified as? Learn more: https://security.cms.gov/learn/federal-information-security-modernization-act-fisma#perform-system-risk-categorization",
+        "license": "What license is the project under?",
+        "vcs": "What version control system is used?",
+        "platforms": "What platform does the software runs on?",
+        "categories": "What categories best describes the project? Separate items by commas. List of categories here: https://yml.publiccode.tools/categories-list.html?highlight=categories",
+        "software_type": "What type of software is the project?",
+        "languages": "What programming language(s) is the software written in? Separate items by commas.",
+        "repo_type": "What type of repository is this project?",
+        "usage_type": "What is the usage type for this project?",
+        "maintenance": "How is the software maintained?",
+        "tags": "Provide a list of tags to describe the software for search. Separate items by commas.",
+        "contact_name": "A point of contact is needed for the project. What is the name of the point of contact?",
+        "contact_email": "What is email address of the point of contact?",
+        "localisation": "Does the software support multiple spoken languages?"
+    }
+}

.github/workflows/auto-changelog.yml

@@ -0,0 +1,15 @@
+name: Changelog
+on:
+  release:
+    types:
+      - created
+jobs:
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Auto Generate changelog"
+        uses: heinrichreimer/action-github-changelog-generator@v2.3
+        with:
+          
+          token: ${{ secrets.GITHUB_TOKEN }}
+          

.github/workflows/checks.yml

@@ -0,0 +1,59 @@
+name: "run-linting-checks"
+on:
+  push:
+    branches:
+      - 'main'
+
+jobs:
+  resolve-repolinter-json:
+    uses: DSACMS/repo-scaffolder/.github/workflows/extendJSONFile.yml@main
+    with: 
+      url_to_json: 'https://raw.githubusercontent.com/DSACMS/repo-scaffolder/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/repolinter.json'
+  
+  repolinter-checks:
+    name: Tier 3 Checks
+    needs: resolve-repolinter-json
+    runs-on: ubuntu-latest
+    env:
+      
+      RAW_JSON: ${{ needs.resolve-repolinter-json.outputs.raw-json }}
+      
+    steps:
+      - uses: actions/checkout@v4
+      - run: echo $RAW_JSON > repolinter.json
+      - uses: newrelic/repolinter-action@v1
+        with:
+          # A path to the JSON/YAML Repolinter ruleset to use, relative to the workflow
+          # working directory (i.e. under `$GITHUB_WORKSPACE`).
+          #
+          # This option is mutually exclusive with config_url. If this option and
+          # config_url are not specified, Repolinter's default ruleset will be used.
+          config_file: 'repolinter.json'
+
+          # Where repolinter-action should put the linting results. There are two
+          # options available:
+          # * "exit-code": repolinter-action will print the lint output to the console
+          #   and set the exit code to result.passed. This output type is most useful for
+          #   PR status checks.
+          # * "issue": repolinter-action will create a GitHub issue on the current
+          #   repository with the repolinter output and always exit 0. See the README for
+          #   more details on issue outputting behavior. This output type is ideal for
+          #   non-intrusive notification.
+          #
+          # Default: "exit-code"
+          output_type: 'issue'
+
+          # The title to use for the issue created by repolinter-action. This title
+          # should indicate the purpose of the issue, as well as that it was created by
+          # a bot.
+          #
+          # This option will be ignored if output_type != "issue".
+          #
+          # Default: "[Repolinter] Open Source Policy Issues"
+          output_name: '[Repolinter] Tier 3 Repository Hygiene Issue'
+
+          # The default token is the repolinter token for the DSACMS org
+          # You can change it if needed.
+          
+          token: ${{ secrets.REPOLINTER_AUTO_TOKEN }}
+          

.github/workflows/contributors.yml

@@ -0,0 +1,78 @@
+name: Update Contributors Information
+
+on:
+  workflow_dispatch: {}
+  schedule:
+    # Weekly on Saturdays.
+    - cron: "30 1 * * 6"
+  push:
+    branches: [main]
+
+jobs:
+  update-contributors:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  
+
+      - name: Update contributor list
+        id: contrib_list
+        uses: akhilmhdh/contributors-readme-action@v2.3.10
+        env:
+          
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          
+        with:
+          readme_path: MAINTAINERS.md
+          use_username: false
+          commit_message: "update contributors information"
+
+      - name: Get contributors count
+        id: get_contributors
+        env:
+          
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          
+
+        run: |
+            OWNER=$(echo $GITHUB_REPOSITORY | cut -d'/' -f1)
+            REPO=$(echo $GITHUB_REPOSITORY | cut -d'/' -f2)
+            QUERY='query { repository(owner: \"'"$OWNER"'\", name: \"'"$REPO"'\") { collaborators { totalCount } } }'
+
+            CONTRIBUTORS=$(gh api \
+              -H "Accept: application/vnd.github+json" \
+              -H "X-GitHub-Api-Version: 2022-11-28" \
+              "/repos/$OWNER/$REPO/contributors?per_page=100" | \
+              jq '[.[] | select(.type != "Bot" and (.login | test("\\[bot\\]$") | not) and (.login | test("-bot$") | not))] | length')
+
+            echo "Total contributors: $CONTRIBUTORS"
+            echo "contributors=$CONTRIBUTORS" >> $GITHUB_OUTPUT
+
+
+      - name: Update MAINTAINERS.md
+        run: |
+          
+          CONTRIBUTORS="${{ steps.get_contributors.outputs.contributors }}"
+          
+
+          perl -i -pe 's/(<!--CONTRIBUTOR COUNT START-->).*?(<!--CONTRIBUTOR COUNT END-->)/$1 '"$CONTRIBUTORS"' $2/' MAINTAINERS.md
+
+          git config user.name 'github-actions[bot]'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+          git add MAINTAINERS.md
+          git commit -m "update contributors count to $CONTRIBUTORS" || exit 0
+
+      - name: Push protected
+        uses: CasperWA/push-protected@v2
+        with:
+          
+          token: ${{ secrets.PUSH_TO_PROTECTED_BRANCH }}
+          
+
+          branch: main