-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Nicolas Bock <nicolasbock@gmail.com>
- Loading branch information
1 parent
eb9ad46
commit 0404165
Showing
4 changed files
with
39 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <https://github.com/lanl/bml/releases> 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. |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters