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

Move Documentation check to separate job #76

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lmbollen
Copy link
Member

Currently all cabal tests can fail due to missing documentation, this is undesirable since we can not distinguish ghc / clash version related problems from missing documentation failures.

@lmbollen lmbollen requested a review from martijnbastiaan May 16, 2024 07:42
@lmbollen lmbollen force-pushed the ci-documentation-job branch from 95b1bb5 to 16f505d Compare May 16, 2024 08:32

- name: Build
run: |
.ci/build_docs.sh -clash_version 9.6.4
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
.ci/build_docs.sh -clash_version 9.6.4
.ci/build_docs.sh --clash_version 9.6.4

https://serverfault.com/a/387938

@lmbollen lmbollen force-pushed the ci-documentation-job branch 4 times, most recently from bf9df64 to 76368a3 Compare May 16, 2024 10:21
@@ -125,3 +121,14 @@ jobs:
- name: Whitespace
run: |
.ci/test_whitespace.sh

documentation:
name: Documentation clash_version 9.6.4
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
name: Documentation clash_version 9.6.4
name: Documentation

9.6.4 => GHC version. But also, it's fine to not mention it in the CI job name anyway.

Copy link
Member

Choose a reason for hiding this comment

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

Also also, why are we setting Clash's version exactly?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good question, I'm removing it entirely

@lmbollen lmbollen force-pushed the ci-documentation-job branch 7 times, most recently from 3fa467d to 403b98a Compare May 16, 2024 14:06
Currently all cabal tests can fail due to missing documentation,
this is undesirable since we can no more distinguish ghc / clash version related problems if documentation does not build
@lmbollen lmbollen force-pushed the ci-documentation-job branch from 403b98a to 8f2a9db Compare May 16, 2024 14:09
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