Skip to content

Commit 1a0c862

Browse files
authored
Update changelog for pre-release (#12)
* bump to rnoaa 1.4.0 * add in the lineal regression for SLR * run formatter * fix file * fix formatting * create changelog for release * add in do not publish to changelog * update changelog
1 parent 1841cc8 commit 1a0c862

File tree

5 files changed

+44
-10
lines changed

5 files changed

+44
-10
lines changed

.github/release.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuration-options
2+
3+
changelog:
4+
exclude:
5+
labels:
6+
- DO NOT MERGE
7+
- No Longer Valid
8+
- Not Reproducible
9+
- Duplicate
10+
- Do not publish

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ repos:
3434
- id: prettier
3535
types_or: [yaml, markdown]
3636
- repo: https://github.com/astral-sh/ruff-pre-commit
37-
rev: v0.11.6
37+
rev: v0.11.7
3838
hooks:
3939
- id: ruff
4040
args: [--fix, --exit-non-zero-on-fix, --output-format=full]

CHANGELOG.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,30 @@
11
# Version 0.2
22

3-
- Upgrade to latest version of NMECR (Version 1.0.17)
4-
- Upgrade to RNOAA 1.4.0
5-
- Add integration and unit test
3+
## What's Changed
4+
5+
- Update nmecr version, add tests for BSync 2.6.0 format by @nllong in https://github.com/BuildingSync/bsyncr/pull/4
6+
- Update README for release instructions by @nllong in https://github.com/BuildingSync/bsyncr/pull/7
7+
- Bump version of RNOAA to 1.4.0 by @nllong in https://github.com/BuildingSync/bsyncr/pull/9
8+
- Add in the linear regression for the SLR plot by @nllong in https://github.com/BuildingSync/bsyncr/pull/10
9+
- Format R source code by @nllong in https://github.com/BuildingSync/bsyncr/pull/11
10+
11+
## New Contributors
12+
13+
- @nllong made their first contribution in https://github.com/BuildingSync/bsyncr/pull/4
14+
15+
**Full Changelog**: https://github.com/BuildingSync/bsyncr/compare/v0.1.0...v0.2.0
616

717
# Version 0.1
818

919
Initial release of the bsyncr package from 2021, which was not previously tagged on GitHub.
20+
21+
## What's Changed
22+
23+
- Feat/updates for seed by @corymosiman12 in https://github.com/BuildingSync/bsyncr/pull/2
24+
- Add models by @macintoshpie in https://github.com/BuildingSync/bsyncr/pull/3
25+
26+
## New Contributors
27+
28+
- @macintoshpie made their first contribution in https://github.com/BuildingSync/bsyncr/pull/3
29+
30+
**Full Changelog**: https://github.com/BuildingSync/bsyncr/commits/v0.1.0

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,16 @@ styler::style_dir()
4545
```
4646

4747
- Create a branch with the prepared release change log.
48-
- Make sure the rnoaa and nmecr versions in `setup_environment.R` and ` are correct.
49-
- Update version in bsync.RProj and DESCRIPTION to the next correct semantic version
50-
- Make sure the DESCRIPTION has the correct version of the dependencies
5148
- For testing purposes, make sure the versions of NMECR and RNOAA are correct in the `setup_environment.R` script
49+
- Update version in `DESCRIPTION` to the next correct semantic version
50+
- Make sure the `DESCRIPTION` has the correct version of the dependencies
5251
- Create CHANGELOG in GitHub, paste in updates into CHANGELOG.md
52+
- Run `pre-commit` locally
5353
- Merge release prep PR to develop
54-
- Test
55-
- 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.
54+
- Test as needed
55+
- 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.
5656
- Back on GitHub create a new tag in GitHub against main and copy the change log notes into the tag description.
57-
- Tag on GitHub, copy over the correct version (format v0.1.0) and CHANGELOG content.
57+
- Tag on GitHub, copy over the correct version (format vX.Y.Z) and CHANGELOG content.
5858

5959
## TODO
6060

cspell.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
"balancepoint",
99
"bsync",
1010
"bsyncr",
11+
"corymosiman",
1112
"crul",
1213
"dataframe",
1314
"datatypeid",
@@ -19,6 +20,8 @@
1920
"hoardr",
2021
"isdparser",
2122
"lubridate",
23+
"macintoshpie",
24+
"nllong",
2225
"NMEC",
2326
"nmecr",
2427
"NOAA",

0 commit comments

Comments
 (0)