Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.9 KB

README.adoc

File metadata and controls

50 lines (33 loc) · 1.9 KB
Raw

CSMI Pre and Post Processing

v2:

Docs CI

This repository contains the source of CSMI Pre and PostProcessing course. It includes:

  • ✓ documentation using asciidoc and antora

  • ❏ Feel++ applications in C++ to use Feel++ and Feel++ toolboxes in src

  • ❏ python Feel++ notebooks that can be downloaded from the documentation

  • ❏ continuous integration including tests for the C++ applications

  • ✓ docker image generation for the course

The documentation for csmi-prepost is available at here and you can build on it for your project by enabling the github pages for your repository.

Setting up CI/CD

  • create an empty .nojekyll in gh-pages

  • in repository settings, add secrets attached to the repository

Developing docs

  • open the project in vscode,

  • stats the devcontainer,

  • run ./antora-preview.sh,

  • start Vscode Liveserver extension, this will open firefox with the website (on port 5500 in the container),

Note
 On the host, you can also use `firefox --private-window http://localhost:5500/' to view the web devsite.
Tip
 you may need to change the port. Check open ports on host with nmap.

Updating the csmi-prepost version

The version of the project is defined in the files CMakeLists.txt, docs/antora.yml and docs/package.json. You need to update with the same version in all files.

Release process

  • ✓ update the version in CMakeLists.txt

  • ✓ update the version in docs/antora.yml

  • ✓ commit the changes with the message "Release vx.y.z". At this point the CI will generate the docker image and push it to docker hub