create changelog for release

Author: nllong

.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]

CHANGELOG.md

@@ -7,3 +7,14 @@
 # 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

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
+- Test as needed
 - 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 v0.1.0) and CHANGELOG content.
+- Tag on GitHub, copy over the correct version (format vX.Y.Z) and CHANGELOG content.
 
 ## TODO