Skip to content

[MDAPI-248][C++] Add automatic documentation generation. #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Apr 10, 2025
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
82 changes: 77 additions & 5 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ on:
tags:
- 'v*.*.*'

permissions:
actions: read
pages: write
id-token: write

jobs:
get_version:
name: Get Version
Expand Down Expand Up @@ -86,6 +91,8 @@ jobs:

steps:
- uses: actions/checkout@v4
with:
ref: ${{needs.get_version.outputs.tag_name}}

- name: Select Xcode version
if: ${{ contains(matrix.config.os, 'macos') }}
Expand Down Expand Up @@ -341,6 +348,68 @@ jobs:
build-Samples/*.zip
build-Tools/*.zip

build_docs_and_upload_and_deploy_gh_pages:
name: "${{ matrix.config.name }}: Build Docs & Upload"
needs: [ get_version ]
strategy:
matrix:
config:
- name: ubuntu-24.04
image: ubuntu-24.04
runs-on: ${{ matrix.config.image }}
steps:
- name: Install Doxygen
run: |
mkdir dox
cd dox
wget https://github.com/doxygen/doxygen/releases/download/Release_1_13_2/doxygen-1.13.2.linux.bin.tar.gz
tar -xf doxygen-1.13.2.linux.bin.tar.gz
cd doxygen-1.13.2
sudo make
sudo make install
doxygen --version
cd ..
cd ..

- uses: actions/checkout@v4
with:
ref: ${{needs.get_version.outputs.tag_name}}

- name: Check 0
run: |
ls

- name: Check
run: |
ls ${{github.workspace}}

- name: Run Doxygen
run: |
cd "${{github.workspace}}/docs"
doxygen ./Doxyfile
cd ..

- name: Pack
run: |
cd "${{github.workspace}}/docs/html"
zip -r ../dxFeedGraalCxxApi-${{needs.get_version.outputs.version}}.zip .

- name: Upload Docs
uses: actions/upload-artifact@v4
with:
name: artifacts-docs
path: |
${{github.workspace}}/docs/*.zip

- name: Upload docs as gh pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: ${{github.workspace}}/docs/html

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

build_full_src_bundle_and_upload:
name: "${{ matrix.config.name }}: Build Full Source Bundle & Upload"
needs: [ get_version ]
Expand All @@ -349,13 +418,16 @@ jobs:
config:
- name: win-vs2022
image: windows-latest
os: windows
cores: 4
cc: 'cl'
cxx: 'cl'
runs-on: ${{ matrix.config.image }}
steps:
- uses: actions/checkout@v4
with:
ref: ${{needs.get_version.outputs.tag_name}}

# - uses: mattnotmitt/doxygen-action@v1.12.0
# with:
# doxyfile-path: './docs/Doxyfile'
# working-directory: '${{github.workspace}}/docs'

- name: Prepare build [Full Source Bundle]
run: |
Expand All @@ -378,7 +450,7 @@ jobs:
if: ${{ inputs.publish || contains(github.event_name, 'push')}}
runs-on: ubuntu-latest
name: Publish Release
needs: [ get_version, build_package_and_upload, build_full_src_bundle_and_upload ]
needs: [ get_version, build_package_and_upload, build_full_src_bundle_and_upload, build_docs_and_upload_and_deploy_gh_pages ]
permissions:
contents: write
steps:
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ project(dxFeedGraalCxxApi)

include(cmake/ParseVersion.cmake)

set(DXFCXX_VERSION "v4.2.0-rc1" CACHE STRING "The dxFeed Graal CXX API package version")
set(DXFCXX_VERSION "v4.2.0-rc9" CACHE STRING "The dxFeed Graal CXX API package version")

dxfcxx_ParseVersion(${DXFCXX_VERSION} DXFCXX_MAJOR_VERSION DXFCXX_MINOR_VERSION DXFCXX_PATCH_VERSION DXFCXX_SUFFIX_VERSION)

Expand Down
1 change: 1 addition & 0 deletions ReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
* Added preparation of library releases for Windows, linked statically with runtime libraries (with parameters: `/MT`,
`/MTd`, `/NODEFAULTLIB:LIBCMT`, `/NODEFAULTLIB:LIBCMTD`). The names of these artifacts end with `-static-mt`, for
example `dxFeedGraalCxxApi-v4.2.0-rc1-x86_64-windows-Release-static-mt.zip`
* **\[MDAPI-248]\[C++]** Now documentation is automatically collected and published on GitHub Pages and released.

## v4.1.0

Expand Down
Loading
Loading