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

feat(ci): add options to disable liquid rendering and run pre-check script #6

Merged
merged 1 commit into from
Aug 15, 2024

Conversation

esolitos
Copy link
Contributor

@esolitos esolitos commented Aug 14, 2024

What

This commit adds a few new options to the Jekyll link checker workflow:

  1. add-no-render-with-liquid
    When set to "true", the workflow will include render_with_liquid: false to all the predefined files (*.md, *.java, *.sd, services.xml, hosts.xml, deployment.xml) before building the site.
    This is useful for preventing liquid rendering in certain files.

  2. pre-check-script
    Allows specifying a path to a script that should be run before the link checking step.
    This can be used to perform additional checks or modifications before the main link checking process.

  3. build-plugins:
    Allows to specify a list of plugins which will be run before the build.

Why

These changes provide more flexibility. Specifically they were part of getting the workflow to work in the repo https://github.com/vespa-engine/sample-apps

Additional info

Related PR:

…cript

This commit adds two new options to the Jekyll link checker workflow:

1. `add-no-render-with-liquid`: When set to "true", this option adds `render_with_liquid: false`
   to a set of files (*.md, *.java, *.sd, services.xml, hosts.xml, deployment.xml) before
   building the site. This is useful for preventing liquid rendering in certain files.

2. `pre-check-script`: Allows specifying a path to a script that should be run before
   the link checking step. This can be used to perform additional checks or
   modifications before the main link checking process.

These changes provide more flexibility and control over the build and link
checking process, allowing users to customize the workflow to their specific
needs.
@kkraune kkraune merged commit 2773cdb into main Aug 15, 2024
2 checks passed
@kkraune kkraune deleted the remove-redirect-files-before-link-check branch August 15, 2024 06:37
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.

2 participants