Skip to content

Commit a27a3b5

Browse files
authored
change log, bump version (#88)
1 parent 1d199d1 commit a27a3b5

File tree

4 files changed

+61
-2
lines changed

4 files changed

+61
-2
lines changed

.github/release.yml

+10
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

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -101,3 +101,15 @@ To autoformat and check file formats run
101101
```bash
102102
poetry run pre-commit --all-files
103103
```
104+
105+
## Releasing
106+
107+
- Create a branch with the prepared release change log.
108+
- Update version in `pyproject.toml`
109+
- Create CHANGELOG in GitHub, paste in updates into CHANGELOG.md
110+
- Run `pre-commit` locally, and commit back changes
111+
- Test as needed
112+
- Merge release prep PR to develop
113+
- 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.
114+
- Back on GitHub create a new tag in GitHub against main and copy the change log notes into the tag description.
115+
- Tag on GitHub, copy over the correct version (format vX.Y.Z) and CHANGELOG content.

cspell.json

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"version": "0.2",
3+
"ignorePaths": [],
4+
"dictionaryDefinitions": [],
5+
"dictionaries": [],
6+
"words": [
7+
"Arvada",
8+
"balancepoint",
9+
"bsync",
10+
"bsyncr",
11+
"crul",
12+
"dataframe",
13+
"datatypeid",
14+
"dplyr",
15+
"Drybulb",
16+
"elec",
17+
"geonames",
18+
"ggplot",
19+
"hoardr",
20+
"isdparser",
21+
"lubridate",
22+
"lxml",
23+
"nllong",
24+
"NMEC",
25+
"nmecr",
26+
"NOAA",
27+
"noaakey",
28+
"rappdirs",
29+
"rnoaa",
30+
"Schematron",
31+
"testthat",
32+
"tidyr"
33+
],
34+
"ignoreWords": [],
35+
"import": []
36+
}

pyproject.toml

+3-2
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@ classifiers = [
1717
"Intended Audience :: Developers",
1818
"Intended Audience :: Science/Research",
1919
"Topic :: Scientific/Engineering",
20-
"Programming Language :: Python :: 3.7",
21-
"Programming Language :: Python :: 3.8",
2220
"Programming Language :: Python :: 3.9",
21+
"Programming Language :: Python :: 3.10",
22+
"Programming Language :: Python :: 3.11",
23+
"Programming Language :: Python :: 3.12",
2324
]
2425

2526
[tool.poetry.dependencies]

0 commit comments

Comments
 (0)