From 7697142a6795cae9337031658b88318c65bfe6f7 Mon Sep 17 00:00:00 2001 From: Nicholas Long Date: Fri, 26 Sep 2025 11:57:15 -0600 Subject: [PATCH 1/3] cleanup instructions --- CHANGELOG.md | 1 + README.md | 2 +- cspell.json | 6 +++++- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 46eb4ac..317b85b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index 468efa1..853ddcc 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,6 @@ 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. diff --git a/cspell.json b/cspell.json index cd07c62..5a325d0 100644 --- a/cspell.json +++ b/cspell.json @@ -5,6 +5,7 @@ "dictionaries": [], "words": [ "Arvada", + "aviveiros", "balancepoint", "bsync", "bsyncr", @@ -20,6 +21,7 @@ "isdparser", "lubridate", "lxml", + "macintoshpie", "nllong", "NMEC", "nmecr", @@ -29,7 +31,9 @@ "rnoaa", "Schematron", "testthat", - "tidyr" + "tidyr", + "virtualenv", + "Xiong" ], "ignoreWords": [], "import": [] From 53482bd889f724ccb9a29e8be9aa6bd441624ba9 Mon Sep 17 00:00:00 2001 From: Nicholas Long Date: Fri, 26 Sep 2025 11:59:09 -0600 Subject: [PATCH 2/3] add dependabot --- .github/dependabot.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..7a48e3f --- /dev/null +++ b/.github/dependabot.yml @@ -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" From 188af7472ce8df4bc4cfcb1d2caba9d8ff9237df Mon Sep 17 00:00:00 2001 From: Nicholas Long Date: Fri, 26 Sep 2025 12:15:29 -0600 Subject: [PATCH 3/3] add in pypi release --- .github/workflows/pypi_release.yml | 55 ++++++++++++++++++++++++++++++ README.md | 1 + 2 files changed, 56 insertions(+) create mode 100644 .github/workflows/pypi_release.yml diff --git a/.github/workflows/pypi_release.yml b/.github/workflows/pypi_release.yml new file mode 100644 index 0000000..9d4f1b3 --- /dev/null +++ b/.github/workflows/pypi_release.yml @@ -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 diff --git a/README.md b/README.md index 853ddcc..dc79977 100644 --- a/README.md +++ b/README.md @@ -113,3 +113,4 @@ poetry run pre-commit --all-files - 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/