Skip to content

Commit

Permalink
Generate PDFs on CI (#274)
Browse files Browse the repository at this point in the history
  • Loading branch information
firthm01 authored Mar 20, 2024
1 parent 809804e commit ed94497
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
39 changes: 38 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,38 @@ on:
- '*'

jobs:
gendocs:
name: Generate PDF Documents
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Generate readme.md from readme.md.in
shell: cmake -P {0}
run: |
file(READ CHANGELOG.md CHANGELOG ENCODING UTF-8)
configure_file(packaging/README.md.in packaging/README.md @ONLY)
- name: Generate PDFs
uses: baileyjm02/markdown-to-pdf@v1
with:
input_dir: packaging
output_dir: packaging/pdfs
build_html: false

- name: Upload PDFs
uses: actions/upload-artifact@v2
with:
name: pdfs
path: packaging/pdfs

build:
name: ${{ matrix.config.name }}
runs-on: ${{ matrix.config.os }}
needs: gendocs
env:
CCACHE_WIN_VERSION: 4.2.1
CCACHE_DIR: ${{ github.workspace }}/.ccache
Expand Down Expand Up @@ -72,7 +101,15 @@ jobs:
with:
submodules: recursive
fetch-depth: 0


- name: Download generated PDFs
uses: actions/download-artifact@v2
with:
name: 'pdfs'
path: packaging
- name: Display structure of downloaded files
run: ls packaging

- name: 'Install ninja-build tool.'
uses: seanmiddleditch/gha-setup-ninja@v3

Expand Down
2 changes: 0 additions & 2 deletions packaging/release_process.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ Merge all changes in to main
Update ./CHANGELOG.md
Update version in ./CMakeLists.txt and ./vcpkg.json
Update ./packaging/README.md.in (version number and summary)
Rerun Configure and Generate in CMake (forces recreation of README.md in build directory from template)
Regenerate PDFs by building target "generate-package-docs" (project files must have been generated with CMake variable EPS_BUILD_PACKAGE=ON)
Commit all, and push
Tag it with version (e.g, git tag -a v0.8.0-EPS-beta -m "v0.8.0 beta release")
Push tag (e.g, git push origin v0.8.0-EPS-beta)
Expand Down

0 comments on commit ed94497

Please sign in to comment.