Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -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
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,15 @@ To autoformat and check file formats run
```bash
poetry run pre-commit --all-files
```

## Releasing

- Create a branch with the prepared release change log.
- Update version in `pyproject.toml`
- Create CHANGELOG in GitHub, paste in updates into CHANGELOG.md
- Run `pre-commit` locally, and commit back changes
- Test as needed
- Merge release prep PR to develop
- 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 vX.Y.Z) and CHANGELOG content.
36 changes: 36 additions & 0 deletions cspell.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"version": "0.2",
"ignorePaths": [],
"dictionaryDefinitions": [],
"dictionaries": [],
"words": [
"Arvada",
"balancepoint",
"bsync",
"bsyncr",
"crul",
"dataframe",
"datatypeid",
"dplyr",
"Drybulb",
"elec",
"geonames",
"ggplot",
"hoardr",
"isdparser",
"lubridate",
"lxml",
"nllong",
"NMEC",
"nmecr",
"NOAA",
"noaakey",
"rappdirs",
"rnoaa",
"Schematron",
"testthat",
"tidyr"
],
"ignoreWords": [],
"import": []
}
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ classifiers = [
"Intended Audience :: Developers",
"Intended Audience :: Science/Research",
"Topic :: Scientific/Engineering",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
]

[tool.poetry.dependencies]
Expand Down