Cleanup instructions #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

nllong merged 3 commits into develop from cleanup

Sep 26, 2025

.github/dependabot.yml

-Original file line number
+Diff line change
@@ -0,0 +1,25 @@
+    version: 2
+    updates:
+      - package-ecosystem: "pip"
+        directory: "/"
+        schedule:
+          interval: "weekly"
+        groups:
+          dev-deps:
+            dependency-type: "development"
+          prod-deps:
+            dependency-type: "production"
+        open-pull-requests-limit: 5
+        commit-message:
+          prefix: "deps"
+      - package-ecosystem: "github-actions"
+        directory: "/"
+        schedule:
+          interval: "weekly"
+        groups:
+          actions-deps:
+            patterns:
+              - "*"
+        open-pull-requests-limit: 5
+        commit-message:
+          prefix: "ci"

.github/workflows/pypi_release.yml

-Original file line number
+Diff line change
@@ -0,0 +1,55 @@
+    name: PyPIRelease
+    # https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+    on:
+      release:
+        types: [published]
+    jobs:
+      build:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v5
+          - name: Set up Python
+            uses: actions/setup-python@v6
+            with:
+              python-version: 3.12
+          - name: Install pypa/build
+            run: >-
+              python3 -m
+              pip install
+              build
+              --user
+          - name: Build a binary wheel and a source tarball
+            run: python3 -m build
+          - name: Store the distribution packages
+            uses: actions/upload-artifact@v4
+            with:
+              name: python-package-distributions
+              path: dist/
+      release:
+        name: >-
+          Publish Python 🐍 distribution 📦 to PyPI
+        needs:
+          - build
+        runs-on: ubuntu-latest
+        environment:
+          name: pypi_release
+          url: https://pypi.org/p/testsuite
+        permissions:
+          id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+        steps:
+          - name: Download all the dists
+            uses: actions/download-artifact@v4
+            with:
+              name: python-package-distributions
+              path: dist/
+          - name: Publish distribution 📦 to PyPI
+            uses: pypa/gh-action-pypi-publish@release/v1

CHANGELOG.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,7 @@ @@
     - chore(deps-dev): bump virtualenv from 20.17.1 to 20.26.6 by @dependabot in https://github.com/BuildingSync/TestSuite/pull/84
     - Bump lxml to 5.3.0 and precommit by @nllong in https://github.com/BuildingSync/TestSuite/pull/85
     - Update license by @nllong in https://github.com/BuildingSync/TestSuite/pull/86
+    - Update CHANGELOG and version for release by @nllong in https://github.com/BuildingSync/TestSuite/pull/87
     **Full Changelog**: https://github.com/BuildingSync/TestSuite/compare/v0.1.3...v0.1.4
@@ Expand Down @@

README.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -110,6 +110,7 @@ poetry run pre-commit --all-files
  
    - Run `pre-commit` locally, and commit back changes

    - Test as needed

    - Merge release prep PR to develop

    - To release, from the command line merge latest develop into latest main: :code:`git merge --ff-only origin develop`. This will point the HEAD of main to latest develop. Then push the main branch to GitHub with :code:`git push`, which may require a developer with elevated privileges to push to main.

    - To release, from the command line merge latest develop into latest main `git merge --ff-only origin develop`. This will point the HEAD of main to latest develop. Then push the main branch to GitHub with `git push`, which may require a developer with elevated privileges to push to main.

    - Back on GitHub create a new tag in GitHub against main and copy the change log notes into the tag description.

    - Tag on GitHub, copy over the correct version (format vX.Y.Z) and CHANGELOG content.

    - Verify the release was published to PyPI https://pypi.org/project/testsuite/

cspell.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -5,6 +5,7 @@ @@
       "dictionaries": [],
       "words": [
         "Arvada",
+        "aviveiros",
         "balancepoint",
         "bsync",
         "bsyncr",
@@ Expand All / @@ -20,6 +21,7 @@ @@
         "isdparser",
         "lubridate",
         "lxml",
+        "macintoshpie",
         "nllong",
         "NMEC",
         "nmecr",
@@ Expand All / @@ -29,7 +31,9 @@ @@
         "rnoaa",
         "Schematron",
         "testthat",
-        "tidyr"
+        "tidyr",
+        "virtualenv",
+        "Xiong"
       ],
       "ignoreWords": [],
       "import": []
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cleanup instructions #89

Uh oh!

Diff view

Diff view

There are no files selected for viewing