-
Sergey Bronnikov authored
Publishing workflow will run building module API documentation for opened or reopened pull request with label "full-ci" and will publish documentation on Github Pages on push to the master branch. NO_CHANGELOG=ci NO_DOC=ci NO_TEST=ci
Sergey Bronnikov authoredPublishing workflow will run building module API documentation for opened or reopened pull request with label "full-ci" and will publish documentation on Github Pages on push to the master branch. NO_CHANGELOG=ci NO_DOC=ci NO_TEST=ci
publish-module-api-doc.yaml 1.37 KiB
name: Publish module API documentation
on:
push:
branches: [master]
pull_request:
types: [opened, reopened, synchronize, labeled]
workflow_dispatch:
jobs:
publish-api-doc:
# Run on push to the branch 'master' or on pull request if the 'full-ci'
# label is set.
if: github.repository == 'tarantool/tarantool' &&
( github.event_name != 'pull_request' ||
contains(github.event.pull_request.labels.*.name, 'full-ci') )
runs-on: ubuntu-latest
steps:
- uses: tarantool/actions/cleanup@master
- uses: actions/checkout@v2.3.4
with:
fetch-depth: 0
submodules: recursive
- name: Setup Doxygen
run: sudo apt install -y doxygen
- name: Build module API documentation using Doxygen
run: |
cmake .
make module_api
sed -e "s%@PROJECT_.\+_DIR@/%%" Doxyfile.API.in > Doxyfile.API
doxygen Doxyfile.API
- name: Publish generated API documentation to GitHub Pages
uses: JamesIves/github-pages-deploy-action@v4.4.0
with:
folder: doc/
if: github.ref == 'refs/heads/master' &&
github.event_name != 'pull_request'
- name: Send VK Teams message on failure
if: failure()
uses: ./.github/actions/report-job-status
with:
bot-token: ${{ secrets.VKTEAMS_BOT_TOKEN }}