Skip to content

Commit

Permalink
v0.1.1-alpha
Browse files Browse the repository at this point in the history
  • Loading branch information
AnatolyKalin committed Aug 31, 2023
1 parent f970a11 commit 943a369
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ endif ()

project(dxFeedGraalCxxApi)

set(DXFCXX_VERSION "0.1.0" CACHE STRING "The dxFeed Graal CXX API package version")
set(DXFCXX_VERSION "0.1.1" CACHE STRING "The dxFeed Graal CXX API package version")

set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
Expand Down
76 changes: 76 additions & 0 deletions HOW_TO_RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# How To Release

## Set the project version*

`*` - unnecessary step, because the version will be retrieved from the tag by GitHub action

- Open CMakeLists.txt
- Set the `DXFCXX_VERSION` property's value:
```cmake
set(DXFCXX_VERSION "0.1.0" CACHE STRING "The dxFeed Graal CXX API package version")
```

### Release

- Make all necessary changes to the Release Notes
- Add the changes:
```shell
git add .
```
- Commit the changes:
```shell
git commit -m "PreRelease v0.1.0-alpha"
```
or
```shell
git commit -m "Release v1.1.0"
```
- Add tag:
```shell
git tag -am "PreRelease v0.1.0-alpha" v0.1.0-alpha
```
or
```shell
git tag -am "Release v1.1.0" v1.1.0
```
- Push the changes:
```shell
git push
```
- Push the tag:
```shell
git push --tags
```

### Build the documentation

- Go to the documentation folder:
```shell
cd docs
```
- Run the doxygen
```shell
doxygen ./Doxyfile
```
- Copy the `html` folder somewhere
- Switch to `gh-pages` git branch
```shell
git switch gh-pages
```
- Copy contents of the "saved" `html` folder to `docs` folder
- Add the changes:
```shell
git add .
```
- Commit the changes:
```shell
git commit -m "PreRelease v0.1.0-alpha"
```
or
```shell
git commit -m "Release v1.1.0"
```
- Push the changes:
```shell
git push
```

0 comments on commit 943a369

Please sign in to comment.