Skip to content

Commit 50a676e

Browse files
authored
Prepare release for version 0.2.0 (#11)
* pre-release * fix spellings
1 parent b506ce2 commit 50a676e

3 files changed

Lines changed: 70 additions & 11 deletions

File tree

CHANGELOG.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
# Version 0.2.0
22

3-
- Upgrade Python
4-
- Upgrade R and related packages (RNOAA, Bsyncr, NMECR)
5-
- Add improved instructions in README
3+
## What's Changed
4+
5+
- Add new bsyncr-server using rocker base image by @dhaley in https://github.com/BuildingSync/bsyncr-server/pull/7
6+
- Update versions, add integration tests, update documentation, restructure files by @nllong in https://github.com/BuildingSync/bsyncr-server/pull/8
7+
- Fix docker auto build for publishing on develop and tags by @nllong in https://github.com/BuildingSync/bsyncr-server/pull/9
8+
- Run R auto style fixes by @nllong in https://github.com/BuildingSync/bsyncr-server/pull/10
9+
10+
## New Contributors
11+
12+
- @dhaley made their first contribution in https://github.com/BuildingSync/bsyncr-server/pull/7
13+
14+
**Full Changelog**: https://github.com/BuildingSync/bsyncr-server/compare/v0.1.0...v0.2.0
615

716
# Version 0.1.0
817

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -114,18 +114,30 @@ e.g.,
114114

115115
## Releasing the stack
116116

117+
There are several steps to releasing all the dependent package of this stack.
118+
119+
1. Ensure that the `requirements.txt` file is pointing to a correct release of the Building/TestSuite package (repository).
120+
2. For building the docker containers, make sure `install_r_packages.R` points to the correct releases of NMECR and RNOAA.
121+
- Verify that the `bsyncr` package install from GitHub is pointing to the correct release (or develop branch for testing).
122+
- These should be the same versions that are used in the `bsyncr` package.
123+
124+
Now follow the process for releasing:
125+
126+
- Create a branch with the prepared release change log.
127+
- For testing purposes, make sure the versions of NMECR and RNOAA are correct in the `install_r_packages.R` script
128+
- Create CHANGELOG in GitHub, paste in updates into CHANGELOG.md. Use semantic versioning for the next version.
129+
- Run `pre-commit` locally
117130
- Format the R files
118-
- Open `bysync-server.Rproj` in RStudio
131+
- Open `bsyncr-server.Rproj` in RStudio
119132
- In RStudio, format all the R files by running the following commands in RStudio
120133

121134
```R
122135
install.packages("styler")
123136
styler::style_dir()
124137
```
125138

126-
There are several steps to releasing all the dependent package of this stack.
127-
128-
1. Ensure that the `requirements.txt` file is pointing to a correct release of the Building/TestSuite package (repository).
129-
2. For building the docker containers, make sure `install_r_packages.R` points to the correct releases of NMECR and RNOAA.
130-
- Verify that the `bsyncr` package install from GitHub is pointing to the correct release (or develop branch for testing).
131-
- These should be the same versions that are used in the `bsyncr` package.
139+
- Merge release prep PR to develop
140+
- Test as needed
141+
- 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.
142+
- Back on GitHub create a new tag in GitHub against main and copy the change log notes into the tag description.
143+
- Tag on GitHub, copy over the correct version (format vX.Y.Z) and CHANGELOG content.

cspell.json

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,75 @@
44
"dictionaryDefinitions": [],
55
"dictionaries": [],
66
"words": [
7+
"arcname",
78
"Arvada",
89
"balancepoint",
910
"bsync",
1011
"bsyncr",
1112
"buildx",
13+
"CAMX",
1214
"crul",
15+
"CVRMSE",
1316
"dataframe",
1417
"datatypeid",
18+
"dhaley",
1519
"docker",
1620
"DOCKERHUB",
1721
"dplyr",
1822
"Drybulb",
1923
"elec",
2024
"elif",
25+
"eload",
2126
"ensurepip",
2227
"esac",
28+
"geonames",
29+
"ggplot",
30+
"ggsave",
31+
"ghcnd",
32+
"hoardr",
33+
"isdparser",
34+
"jsonify",
35+
"libbz",
36+
"libfontconfig",
37+
"libfreetype",
38+
"libfribidi",
39+
"libgit",
40+
"libharfbuzz",
41+
"libjpeg",
42+
"libncurses",
43+
"libreadline",
44+
"libsqlite",
2345
"libv",
2446
"libxmlsec",
47+
"linetype",
48+
"lubridate",
49+
"macintoshpie",
50+
"NDBE",
51+
"nllong",
52+
"NMBE",
2553
"NMEC",
2654
"nmecr",
2755
"NOAA",
2856
"noaakey",
57+
"nrel",
2958
"PYENV",
3059
"PYTHONDONTWRITEBYTECODE",
3160
"PYTHONUNBUFFERED",
61+
"rappdirs",
62+
"Renviron",
63+
"rjson",
3264
"RMPA",
3365
"rnoaa",
66+
"ropensci",
67+
"Rproj",
68+
"Rscript",
3469
"schematron",
3570
"seedplatform",
71+
"Sweave",
3672
"testthat",
37-
"tidyr"
73+
"tidyr",
74+
"tmpdirname",
75+
"xlab"
3876
],
3977
"ignoreWords": [],
4078
"import": []

0 commit comments

Comments
 (0)