Skip to content
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

chore: update the CI to compile and deploy Antora docs #1140

Merged
merged 8 commits into from
Nov 26, 2024

Conversation

zepfred
Copy link
Contributor

@zepfred zepfred commented Oct 10, 2024

The PR updates the secure PR pipeline and adds a new job for compiling and deploying the Antora docs.

  1. The compilation step is necessary because certain errors are only detected during the release process, which could delay the solver's release.
  2. The deployment step can help identify issues during the documentation development phase, such as incorrect title configuration, inconsistent menu items, etc.
  3. The deployment step ensures that it is not used on the main branch and that the production remains unchanged.

Copy link

.github/workflows/pull_request_secure.yml Outdated Show resolved Hide resolved
docs/src/antora-playbook-template.yml Outdated Show resolved Hide resolved
@triceo
Copy link
Contributor

triceo commented Nov 26, 2024

@pieterdeschepper Please review.

@zepfred Maybe we want to remove the -Dfull from the solver CI? It exists to build the docs, but now that we have a separate job for it, we can save some time.

(The failure has been fixed in the meantime.)

@triceo triceo merged commit 2009fa8 into TimefoldAI:main Nov 26, 2024
27 checks passed
@triceo triceo added this to the 1.17.0 milestone Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants