diff --git a/CMakeLists.txt b/CMakeLists.txt index a7ec2163b..a75468194 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -14,7 +14,7 @@ project(bml ${LANGUAGES}) # don't move this line as it changes PROJECT_SOURCE_DI # The library version is versioned off the major version. If the API # changes, the library version should be bumped. set(PROJECT_VERSION_MAJOR "2") -set(PROJECT_VERSION_MINOR "2") +set(PROJECT_VERSION_MINOR "3") set(PROJECT_VERSION_PATCH "0") set(PROJECT_VERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}") diff --git a/RELEASEMANAGEMENT.md b/RELEASEMANAGEMENT.md new file mode 100644 index 000000000..225e5f713 --- /dev/null +++ b/RELEASEMANAGEMENT.md @@ -0,0 +1,37 @@ +# Release Management + +When creating a new release, make sure to update the following files: + +- `CMakeLists.txt` + + ```markdown + # The library version is versioned off the major version. If the API + # changes, the library version should be bumped. + set(PROJECT_VERSION_MAJOR "2") + set(PROJECT_VERSION_MINOR "3") + set(PROJECT_VERSION_PATCH "0") + ``` + +- `docs/source/conf.py` + + ```python + # The full version, including alpha/beta/rc tags + release = 'v2.3.0' + ``` + +Create an annotated tag: + +```console + git tag --annotate --sign --message='Release v2.3.0' v2.3.0 +``` + +Or use the GitHub UI at to create a new +release. + +The changelog can be generated via + +```console + git log --oneline --no-decorate --no-merges v2.2.0..v2.3.0 + ``` + + Or using the GitHub UI. diff --git a/bml-manual.pdf b/bml-manual.pdf deleted file mode 100644 index 1ad6bd614..000000000 Binary files a/bml-manual.pdf and /dev/null differ diff --git a/docs/source/conf.py b/docs/source/conf.py index 550c1f95c..3eea8d225 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -21,7 +21,7 @@ author = 'bml authors' # The full version, including alpha/beta/rc tags -release = 'v2.2.0' +release = 'v2.3.0' # -- General configuration ---------------------------------------------------