Merge pull request #3 from github/open-source-prep

Prep to Open Source

Author: crimsonknave

.github/workflows/build-and-upload.yaml

@@ -38,14 +38,3 @@ jobs:
       - name: Build Package
         uses: ./ # Action defined in action.yaml in the root
         if: steps.changed-files.outputs.any_changed == 'true'
-
-      - name: Setup Octofactory config
-        uses: jfrog/setup-jfrog-cli@7c95feb32008765e1b4e626b078dfd897c4340ad
-        if: steps.changed-files.outputs.any_changed == 'true'
-        env:
-          JF_ENV_1: ${{ secrets.OCTOFACTORY_SERVER_CONFIG }}
-
-      - name: Upload to Octofactory
-        if: steps.changed-files.outputs.any_changed == 'true'
-        run: |
-          jfrog rt u dist/ logger-decorator-pypi

.github/workflows/coverage.yaml

@@ -0,0 +1,23 @@
+
+name: Post Coverage Commit
+
+on:
+  workflow_run:
+    workflows: ["Pytest"]
+    types:
+      - completed
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    if: github.event.workflow_run.event == "pull_request" && github.event.workflow_run.conclusion == "success"
+    permissions:
+      pull-requests: write
+      contents: write
+      actions: read
+    steps:
+    - name: Python Coverage Comment
+      uses: py-cov-action/python-coverage-comment-action@b2eb38dd175bf053189b35f738f9207278b00925
+      with:
+        GITHUB_TOKEN: ${{ github.token }}
+        GITHUB_PR_RUN_ID: ${{ github.event.workflow_run.id }}

.github/workflows/matchers/ruff.json

@@ -0,0 +1,14 @@
+{
+  "problemMatcher": [
+    {
+      "owner": "ruff",
+      "pattern": [
+        {
+          "regexp": "^(Would reformat): (.+)$",
+          "message": 1,
+          "file": 2
+        }
+      ]
+    }
+  ]
+}

.github/workflows/mutation.yaml

@@ -11,6 +11,8 @@ on:
 jobs:
   # Checks that version number has been updated
   package-quality-control:
+    permissions:
+      contents: read
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Current PR Branch
@@ -19,7 +21,7 @@ jobs:
         uses: actions/setup-python@v5
       - name: Check for Changed Files
         id: changed-files
-        uses: tj-actions/changed-files@v44
+        uses: tj-actions/changed-files@635f118699dd888d737c15018cd30aff2e0274f8
         with:
           files: |
             pyproject.toml

.github/workflows/package-quality-control.yaml

@@ -5,6 +5,8 @@ on:
 
 jobs:
   pyright:
+    permissions:
+      contents: read
 
     runs-on: ubuntu-latest
     steps:
@@ -19,4 +21,4 @@ jobs:
         hatch env create dev
     - run: echo "$(hatch env find dev)/bin" >> $GITHUB_PATH
     - name: Run pyright
-      uses: jakebailey/pyright-action@v2.3.1
+      uses: jakebailey/pyright-action@b5d50e5cde6547546a5c4ac92e416a8c2c1a1dfe

.github/workflows/pyright.yaml

@@ -8,17 +8,14 @@ on:
 
 jobs:
   pytest:
+    permissions:
+      contents: read
 
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.9", "3.10", "3.11", "pypy3.9", "pypy3.10"]
-        exclude:
-          - os: macos-latest
-            python-version: "3.9"
-          - os: windows-latest
-            python-version: "3.9"
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
     - uses: actions/checkout@v4
@@ -35,7 +32,6 @@ jobs:
         # Need relative files for the action to report, but it messes up mutmut
         echo "[run]" >> .coveragerc
         echo "relative_files = true" >> .coveragerc
-        cat .coveragerc
 
         hatch run dev:pytest
       env:
@@ -45,27 +41,36 @@ jobs:
       with:
         name: coverage-${{ matrix.os }}-${{ matrix.python-version }}
         path: .coverage.${{ matrix.os }}.${{ matrix.python-version }}
+        include-hidden-files: true
 
   coverage:
+    name: Coverage
     runs-on: ubuntu-latest
     needs: pytest
     permissions:
       pull-requests: write
       contents: write
     steps:
     - uses: actions/checkout@v4
-
     - uses: actions/download-artifact@v4
       id: download
       with:
         pattern: coverage-*
         merge-multiple: true
     - name: Re-add relative so the action is happy
       run: |
+        # Need relative files for the action to report, but it messes up mutmut
         echo "[run]" >> .coveragerc
         echo "relative_files = true" >> .coveragerc
     - name: Python Coverage Comment
-      uses: py-cov-action/python-coverage-comment-action@v3.24
+      uses: py-cov-action/python-coverage-comment-action@b2eb38dd175bf053189b35f738f9207278b00925
       with:
         GITHUB_TOKEN: ${{ github.token }}
         MERGE_COVERAGE_FILES: true
+    - name: Store Pull Request comment to be posted
+      uses: actions/upload-artifact@v4
+      if: steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true'
+      with:
+        name: python-coverage-comment-action
+        path: python-coverage-comment-action.txt
+        include-hidden-files: true

.github/workflows/pytest.yaml

@@ -5,6 +5,8 @@ on:
 
 jobs:
   ruff:
+    permissions:
+      contents: read
 
     runs-on: ubuntu-latest
     steps:
@@ -17,6 +19,11 @@ jobs:
       run: |
         python -m pip install hatch
         hatch env create dev
-    - name: Lint with Ruff
+    - name: Lint with Ruff (check)
       run: |
-        hatch run dev:ruff --output-format=github .
+        hatch run dev:ruff check --output-format=github .
+    - name: Register problem matcher for ruff format
+      run: echo "::add-matcher::.github/workflows/matchers/ruff.json"
+    - name: Lint with Ruff (format)
+      run: |
+        hatch run dev:ruff format --check .

.github/workflows/ruff.yaml

@@ -8,7 +8,7 @@ repos:
   # Run the formatter.
   - id: ruff-format
 - repo: https://github.com/RobertCraigie/pyright-python
-  rev: v1.1.355
+  rev: v1.1.382
   hooks:
   - id: pyright
     # I don't love having to specify these here, but pre-commit only seems to work

.pre-commit-config.yaml

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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 to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <opensource@github.com>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/