functionality complete

Signed-off-by: Sachin Panayil <[email protected]>

Author: sachin-panayil

.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/[email protected]
+        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/tier2/%7B%7Bcookiecutter.project_slug%7D%7D/repolinter.json'
+  
+  repolinter-checks:
+    name: Tier 2 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 2 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/[email protected]
+        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

.github/workflows/gitleaks.yml

@@ -0,0 +1,18 @@
+name: Check for Secrets
+on:
+    pull_request:
+    push:
+
+jobs:
+  scan-for-secrets:
+    name: Run gitleaks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: gitleaks/gitleaks-action@v2
+        env:
+          
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          

.gitignore

@@ -0,0 +1,4 @@
+#pycache
+__pycache__/
+*.pyc
+

CODEOWNERS.md

@@ -0,0 +1,32 @@
+# Code Owners
+<!-- TODO: Who are the points of contact in your project who are responsible/accountable for the project? This can often be an engineering or design manager or leader, who may or may not be the primary maintainers of the project. List them by GitHub Username-->
+
+- sachin-panayil
+
+
+## Repo Domains
+
+<!--
+The Repo Domains section of your CODEOWNERS.md file helps manage code review responsibilities efficiently. Each domain represents a different aspect of the repository, such as documentation, frontend, backend, DevOps, testing, etc. In this section, list each domain and assign the appropriate GitHub usernames or teams responsible for that domain. This ensures that pull requests (PRs) are reviewed by the right experts, maintaining high code quality and relevance.
+
+For example:
+
+/docs/ @doc-team @johnsmith @janedoe
+
+/frontend/ @frontend-team @alice @bob
+
+/backend/ @backend-team @charlie @dana
+
+Furthermore, GitHub teams are a good feature for managing groups of contributors who need to be notified about specific domains within a repository. By creating and using GitHub teams, you can allow contributors to ping multiple relevant experts simultaneously.
+
+To set up GitHub teams:
+
+- Navigate to your organization's settings and select "Teams".
+- Create a new team for each domain, such as @frontend-team, @backend-team, or @doc-team.
+- Add the relevant members to each team. Ensure that the team includes all the individuals who should be notified about PRs in their domain.
+- When filling out the Repo Domains section in your CODEOWNERS.md file, use the team handles instead of or alongside individual usernames. This way, when a contributor opens a PR affecting a specific domain, they can simply tag the team, and every member of that team will be notified.
+
+-->
+
+/docs/ {Git usernames of documentation owners}  
+/frontend/ {Git usernames of frontend owners}

CODE_OF_CONDUCT.md

@@ -0,0 +1,17 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of experience, gender, gender identity, expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers at [email protected].
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
+
+## Acknowledgements
+
+This CODE_OF_CONDUCT.md was originally forked from the [United States Digital Service](https://usds.gov) [Justice40](https://thejustice40.com) open source [repository](https://github.com/usds/justice40-tool), and we would like to acknowledge and thank the community for their contributions.

COMMUNITY_GUIDELINES.md

@@ -0,0 +1,37 @@
+# codejson-index-generator Open Source Community Guidelines
+
+This document contains principles and guidelines for participating in the codejson-index-generator open source community.
+
+## Principles
+
+These principles guide our data, product, and process decisions, architecture, and approach.
+
+- Open means transparent and participatory.
+- We take a modular and modern approach to software development.
+- We build open-source software and open-source process.
+- We value ease of implementation.
+- Fostering community includes building capacity and making our software and processes accessible to participants with diverse backgrounds and skillsets.
+- Data (and data science) is as important as software and process. We build open data sets where possible.
+- We strive for transparency for algorithms and places we might be introducing bias.
+
+## Community Guidelines
+
+All community members are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+Information on contributing to this repository is available in our [Contributing file](CONTRIBUTING.md).
+
+When participating in codejson-index-generator open source community conversations and spaces, we ask individuals to follow the following guidelines:
+
+- When joining a conversation for the first time, please introduce yourself by providing a brief intro that includes:
+  - your related organization (if applicable)
+  - your pronouns
+  - your superpower, and how you hope to use it for codejson-index-generator
+- Embrace a culture of learning, and educate each other. We are all entering this conversation from different starting points and with different backgrounds. There are no dumb questions.
+- Take space and give space. We strive to create an equitable environment in which all are welcome and able to participate. We hope individuals feel comfortable voicing their opinions and providing contributions and will do our best to recognize and make space for individuals who may be struggling to find space here. Likewise, we expect individuals to recognize when they are taking up significant space and take a step back to allow room for others.
+<!-- TODO: Add if your repo has a community chat - Be present when joining synchronous conversations such as our community chat. Why be here if you're not going to _be here_? -->
+- Be respectful.
+- Default to positive. Assume others' contributions are legitimate and valuable and that they are made with good intention.
+
+## Acknowledgements
+
+This COMMUNITY_GUIDELINES.md was originally forked from the [United States Digital Service](https://usds.gov) [Justice40](https://thejustice40.com) open source [repository](https://github.com/usds/justice40-tool), and we would like to acknowledge and thank the community for their contributions.