Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 963 Bytes

RELEASEMANAGEMENT.md

File metadata and controls

45 lines (31 loc) · 963 Bytes
Raw

Release Management

When creating a new release, make sure to update the following files:

  • CMakeLists.txt

    # 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

    # The full version, including alpha/beta/rc tags
release = 'v2.3.0'

  • Updated API documentation

    ./scripts/run-local-docker-container.sh ./build.sh docs

    and commit any changes.

Create an annotated tag:

 git tag --annotate --sign --message='Release v2.3.0' v2.3.0

Or use the GitHub UI at https://github.com/lanl/bml/releases to create a new release.

The changelog can be generated via

 git log --oneline --no-decorate --no-merges v2.2.0..v2.3.0

Or using the GitHub UI.