From 509903f62587817ef9779fd1ecac3a6b948b0fed Mon Sep 17 00:00:00 2001 From: Nicholas Long Date: Sat, 26 Apr 2025 16:37:08 -0600 Subject: [PATCH] change log, bump version --- .github/release.yml | 10 ++++++++++ README.md | 12 ++++++++++++ cspell.json | 36 ++++++++++++++++++++++++++++++++++++ pyproject.toml | 5 +++-- 4 files changed, 61 insertions(+), 2 deletions(-) create mode 100644 .github/release.yml create mode 100644 cspell.json diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 0000000..745abdd --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,10 @@ +# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuration-options + +changelog: + exclude: + labels: + - DO NOT MERGE + - No Longer Valid + - Not Reproducible + - Duplicate + - Do not publish diff --git a/README.md b/README.md index 808d33e..468efa1 100644 --- a/README.md +++ b/README.md @@ -101,3 +101,15 @@ To autoformat and check file formats run ```bash poetry run pre-commit --all-files ``` + +## Releasing + +- Create a branch with the prepared release change log. +- Update version in `pyproject.toml` +- Create CHANGELOG in GitHub, paste in updates into CHANGELOG.md +- 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. +- 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 new file mode 100644 index 0000000..cd07c62 --- /dev/null +++ b/cspell.json @@ -0,0 +1,36 @@ +{ + "version": "0.2", + "ignorePaths": [], + "dictionaryDefinitions": [], + "dictionaries": [], + "words": [ + "Arvada", + "balancepoint", + "bsync", + "bsyncr", + "crul", + "dataframe", + "datatypeid", + "dplyr", + "Drybulb", + "elec", + "geonames", + "ggplot", + "hoardr", + "isdparser", + "lubridate", + "lxml", + "nllong", + "NMEC", + "nmecr", + "NOAA", + "noaakey", + "rappdirs", + "rnoaa", + "Schematron", + "testthat", + "tidyr" + ], + "ignoreWords": [], + "import": [] +} diff --git a/pyproject.toml b/pyproject.toml index 52538a8..bcf708b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,9 +17,10 @@ classifiers = [ "Intended Audience :: Developers", "Intended Audience :: Science/Research", "Topic :: Scientific/Engineering", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", ] [tool.poetry.dependencies]