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

Make --strict toggleable for mkdocs build #78

Merged
merged 3 commits into from
Nov 16, 2022
Merged

Conversation

CasperWA
Copy link
Collaborator

@CasperWA CasperWA commented Nov 16, 2022

Fixes #77

Revert commit d525ea0.

Make the addition/usage of the --strict option toggleable according to a new warnings_as_errors boolean input.
By default, this is set to true and must explicitly be set to false.

If warnings_as_errors is set to false, a warning will be emitted in the Actions workflow run.

@CasperWA CasperWA marked this pull request as ready for review November 16, 2022 13:06
@daniel-sintef
Copy link
Contributor

How would you use this in a downstream ci file? You can just link me to the documentation of how to use this

Copy link
Contributor

@daniel-sintef daniel-sintef left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I just want to know how to use it downstream :)

@CasperWA
Copy link
Collaborator Author

CasperWA commented Nov 16, 2022

How would you use this in a downstream ci file? You can just link me to the documentation of how to use this

I would set the appropriate input parameter (warnings_as_errors) to the value one desires (true (default) for using warnings as errors; false for not doing so).
Updated documentation: https://github.com/SINTEF/ci-cd/blob/cwa/fix-77-undo-bad-change/docs/workflows/ci_tests.md#inputs-3
In raw format, and specifically: https://github.com/SINTEF/ci-cd/blob/cwa/fix-77-undo-bad-change/docs/workflows/ci_tests.md?plain=1#L119

An example of how to use the workflows in general is described in the general GitHub documentation (they're called "callable workflows") referenced in the main pages of the documentation as well as an example in each workflow-specific documentation page.
For the CI - Tests workflow, the example is here: https://github.com/SINTEF/ci-cd/blob/cwa/fix-77-undo-bad-change/docs/workflows/ci_tests.md#usage-example

@CasperWA CasperWA merged commit 5a61578 into main Nov 16, 2022
@CasperWA CasperWA deleted the cwa/fix-77-undo-bad-change branch November 16, 2022 15:54
@CasperWA
Copy link
Collaborator Author

CasperWA commented Nov 16, 2022

In general, the documentation exists here: https://sintef.github.io/ci-cd

Here, you'll find this section "General usage": https://sintef.github.io/ci-cd/latest/#general-usage

@daniel-sintef
Copy link
Contributor

Great, thanks!

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.

Undo commit d525ea0f069b6615aa352a7f385c21b31f29b985
2 participants