first commit

Signed-off-by: Zack Koppert <[email protected]>

.coveragerc

@@ -0,0 +1,4 @@
+[run]
+omit =
+    # omit test files
+    test_*.py

.env-example

@@ -0,0 +1,2 @@
+GH_TOKEN = " "
+ORGANIZATION = "organization"

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @zkoppert

.github/dependabot.yml

@@ -0,0 +1,20 @@
+---
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/linters/.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 150
+extend-ignore = C901

.github/linters/.isort.cfg

@@ -0,0 +1,2 @@
+[isort]
+profile = black

.github/linters/.jscpd.json

@@ -0,0 +1,7 @@
+{
+  "threshold": 25,
+  "ignore": [
+    "test*"
+  ],
+  "absolute": true
+}

.github/linters/.markdown-lint.yml

@@ -0,0 +1,26 @@
+---
+###########################
+###########################
+## Markdown Linter rules ##
+###########################
+###########################
+
+# Linter rules doc:
+# - https://github.com/DavidAnson/markdownlint
+#
+# Note:
+# To comment out a single error:
+#   <!-- markdownlint-disable -->
+#   any violations you want
+#   <!-- markdownlint-restore -->
+#
+
+###############
+# Rules by id #
+###############
+# line length
+MD013: false
+# singe h1
+MD025: false
+# duplicate headers
+MD024: false

.github/linters/.mypy.ini

@@ -0,0 +1,4 @@
+# Global options:
+
+[mypy]
+disable_error_code = attr-defined, import-not-found

.github/linters/.shellcheckrc

@@ -0,0 +1,2 @@
+# Don't suggest [ -n "$VAR" ] over [ ! -z "$VAR" ] 
+disable=SC2129

.github/linters/.textlintrc

@@ -0,0 +1,10 @@
+{
+  "filters": {
+    "comments": true
+  },
+  "rules": {
+    "terminology": {
+      "severity": "warning"
+    }
+  }
+}

.github/linters/.yaml-lint.yml

@@ -0,0 +1,59 @@
+---
+###########################################
+# These are the rules used for            #
+# linting all the yaml files in the stack #
+# NOTE:                                   #
+# You can disable line with:              #
+# # yamllint disable-line                 #
+###########################################
+rules:
+  braces:
+    level: warning
+    min-spaces-inside: 0
+    max-spaces-inside: 0
+    min-spaces-inside-empty: 1
+    max-spaces-inside-empty: 5
+  brackets:
+    level: warning
+    min-spaces-inside: 0
+    max-spaces-inside: 0
+    min-spaces-inside-empty: 1
+    max-spaces-inside-empty: 5
+  colons:
+    level: warning
+    max-spaces-before: 0
+    max-spaces-after: 1
+  commas:
+    level: warning
+    max-spaces-before: 0
+    min-spaces-after: 1
+    max-spaces-after: 1
+  comments: disable
+  comments-indentation: disable
+  document-end: disable
+  document-start:
+    level: warning
+    present: true
+  empty-lines:
+    level: warning
+    max: 2
+    max-start: 0
+    max-end: 0
+  hyphens:
+    level: warning
+    max-spaces-after: 1
+  indentation:
+    level: warning
+    spaces: consistent
+    indent-sequences: true
+    check-multi-line-strings: false
+  key-duplicates: enable
+  line-length:
+    level: warning
+    max: 1024
+    allow-non-breakable-words: true
+    allow-non-breakable-inline-mappings: true
+  new-line-at-end-of-file: disable
+  new-lines:
+    type: unix
+  trailing-spaces: disable

.github/pull_request_template.md

@@ -0,0 +1,17 @@
+# Pull Request
+<!-- PR title should be brief and descriptive for a good changelog entry -->
+
+## Proposed Changes
+<!-- Describe what the changes are and link to a GitHub Issue if one exists -->
+
+## Readiness Checklist
+
+### Author/Contributor
+
+- [ ] If documentation is needed for this change, has that been included in this pull request
+- [ ] run `make lint` and fix any issues that you have introduced
+- [ ] run `make test` and ensure you have test coverage for the lines you are introducing
+
+### Reviewer
+
+- [ ] Label as either `bug`, `documentation`, `enhancement`, `infrastructure`, or `breaking`

.github/release-drafter.yml

@@ -0,0 +1,41 @@
+---
+name-template: 'v$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+template: |
+  # Changelog
+  $CHANGES
+  
+  See details of [all code changes](https://github.com/github/cleanowners/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION) since previous release 
+  
+categories:
+  - title: '🚀 Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'fix'
+      - 'bugfix'
+      - 'bug'
+  - title: '🧰 Maintenance'
+    labels:
+      - 'infrastructure'
+      - 'automation'
+      - 'documentation'
+      - 'dependencies'
+  - title: '🏎 Performance'
+    label: 'performance'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+version-resolver:
+  major:
+    labels:
+      - 'breaking'
+  minor:
+    labels:
+      - 'enhancement'
+  patch:
+    labels:
+      - 'bug'
+      - 'maintenance'
+      - 'documentation'
+  default: patch

.github/workflows/contributors_report.yaml

@@ -0,0 +1,45 @@
+---
+name: Monthly contributor report
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '3 2 1 * *'
+
+permissions:
+  issues: write
+
+jobs:
+  contributor_report:
+    name: contributor report
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Get dates for last month
+        shell: bash
+        run: |
+          # Calculate the first day of the previous month
+          start_date=$(date -d "last month" +%Y-%m-01)
+  
+          # Calculate the last day of the previous month
+          end_date=$(date -d "$start_date +1 month -1 day" +%Y-%m-%d)
+
+          #Set an environment variable with the date range
+          echo "START_DATE=$start_date" >> "$GITHUB_ENV"
+          echo "END_DATE=$end_date" >> "$GITHUB_ENV"
+
+      - name: Run contributor action
+        uses: github/contributors@v1
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          START_DATE: ${{ env.START_DATE }}
+          END_DATE: ${{ env.END_DATE }}
+          REPOSITORY: github/cleanowners
+          SPONSOR_INFO: "true"
+
+      - name: Create issue
+        uses: peter-evans/create-issue-from-file@v5
+        with:
+          title: Monthly contributor report
+          token: ${{ secrets.GITHUB_TOKEN }}
+          content-filepath: ./contributors.md
+          assignees: zkoppert

.github/workflows/docker-ci.yml

@@ -0,0 +1,19 @@
+---
+name: Docker Image CI
+
+on:
+  push:
+    branches: main
+  pull_request:
+    branches: main
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build the Docker image
+        run: docker build . --file Dockerfile --platform linux/amd64

.github/workflows/major-version-updater.yml

@@ -0,0 +1,30 @@
+---
+name: Major Version Updater
+# Whenever a new release is made, push a major version tag
+on:
+  release:
+    types: published
+
+jobs:
+  update-major-version-tag:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - name: version
+        id: version
+        shell: bash
+        run: |
+          # shellcheck disable=all
+          tag=${GITHUB_REF/refs\/tags\//};
+          version=${tag#v} ;
+          major=${version%%.*} ;
+          echo "tag=${tag}" >> "$GITHUB_OUTPUT" ;
+          echo "version=${version}" >> "$GITHUB_OUTPUT" ;
+          echo "major=${major}" >> "$GITHUB_OUTPUT" ;
+
+      - name: force update major tag
+        run: |
+          git tag v${{ steps.version.outputs.major }}
+          git push origin refs/tags/v${{ steps.version.outputs.major }} -f

.github/workflows/python-ci.yml

@@ -0,0 +1,37 @@
+---
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python package
+
+on:
+  push:
+    branches: main
+  pull_request:
+    branches: main
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.11, 3.12]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install flake8 pylint pytest pytest-cov
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: Lint with flake8 and pylint
+        run: |
+          make lint
+      - name: Test with pytest
+        run: |
+          make test

.github/workflows/release-drafter.yml

@@ -0,0 +1,16 @@
+---
+name: Release Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - main
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}