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/.pre-commit-config.yaml b/.pre-commit-config.yaml index 85e491a..510eece 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -34,7 +34,7 @@ repos: - id: prettier types_or: [yaml, markdown] - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.11.6 + rev: v0.11.7 hooks: - id: ruff args: [--fix, --exit-non-zero-on-fix, --output-format=full] diff --git a/CHANGELOG.md b/CHANGELOG.md index 2f69358..91246e9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,30 @@ # Version 0.2 -- Upgrade to latest version of NMECR (Version 1.0.17) -- Upgrade to RNOAA 1.4.0 -- Add integration and unit test +## What's Changed + +- Update nmecr version, add tests for BSync 2.6.0 format by @nllong in https://github.com/BuildingSync/bsyncr/pull/4 +- Update README for release instructions by @nllong in https://github.com/BuildingSync/bsyncr/pull/7 +- Bump version of RNOAA to 1.4.0 by @nllong in https://github.com/BuildingSync/bsyncr/pull/9 +- Add in the linear regression for the SLR plot by @nllong in https://github.com/BuildingSync/bsyncr/pull/10 +- Format R source code by @nllong in https://github.com/BuildingSync/bsyncr/pull/11 + +## New Contributors + +- @nllong made their first contribution in https://github.com/BuildingSync/bsyncr/pull/4 + +**Full Changelog**: https://github.com/BuildingSync/bsyncr/compare/v0.1.0...v0.2.0 # Version 0.1 Initial release of the bsyncr package from 2021, which was not previously tagged on GitHub. + +## What's Changed + +- Feat/updates for seed by @corymosiman12 in https://github.com/BuildingSync/bsyncr/pull/2 +- Add models by @macintoshpie in https://github.com/BuildingSync/bsyncr/pull/3 + +## New Contributors + +- @macintoshpie made their first contribution in https://github.com/BuildingSync/bsyncr/pull/3 + +**Full Changelog**: https://github.com/BuildingSync/bsyncr/commits/v0.1.0 diff --git a/README.md b/README.md index b2ab81f..626b004 100644 --- a/README.md +++ b/README.md @@ -45,16 +45,16 @@ styler::style_dir() ``` - Create a branch with the prepared release change log. -- Make sure the rnoaa and nmecr versions in `setup_environment.R` and ` are correct. -- Update version in bsync.RProj and DESCRIPTION to the next correct semantic version -- Make sure the DESCRIPTION has the correct version of the dependencies - For testing purposes, make sure the versions of NMECR and RNOAA are correct in the `setup_environment.R` script +- Update version in `DESCRIPTION` to the next correct semantic version +- Make sure the `DESCRIPTION` has the correct version of the dependencies - Create CHANGELOG in GitHub, paste in updates into CHANGELOG.md +- Run `pre-commit` locally - Merge release prep PR to develop -- Test -- 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. +- Test as needed +- 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 v0.1.0) and CHANGELOG content. +- Tag on GitHub, copy over the correct version (format vX.Y.Z) and CHANGELOG content. ## TODO diff --git a/cspell.json b/cspell.json index 8e0bf27..323b77f 100644 --- a/cspell.json +++ b/cspell.json @@ -8,6 +8,7 @@ "balancepoint", "bsync", "bsyncr", + "corymosiman", "crul", "dataframe", "datatypeid", @@ -19,6 +20,8 @@ "hoardr", "isdparser", "lubridate", + "macintoshpie", + "nllong", "NMEC", "nmecr", "NOAA",