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

Fix haddocks generation in GHA #241

Merged
merged 1 commit into from
Sep 14, 2023
Merged

Conversation

carbolymer
Copy link
Contributor

@carbolymer carbolymer commented Sep 13, 2023

Changelog

- description: |
    Fix haddocks generation in GHA
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  # - improvement    # QoL changes e.g. refactoring
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
   - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

This PR reuses https://github.com/input-output-hk/cardano-node/blob/master/scripts/haddocs.sh from cardano-node

Fixes #188

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • The change log section in the PR description has been filled in
  • New tests are added if needed and existing tests are updated. These may include:
    • golden tests
    • property tests
    • round trip tests
    • integration tests
      See Running tests for more details
  • The version bounds in .cabal files are updated
  • CI passes. See note on CI. The following CI checks are required:
    • Code is linted with hlint. See .github/workflows/check-hlint.yml to get the hlint version
    • Code is formatted with stylish-haskell. See .github/workflows/stylish-haskell.yml to get the stylish-haskell version
    • Code builds on Linux, MacOS and Windows for ghc-8.10.7 and ghc-9.2.7
  • The changelog section in the PR is updated to describe the change
  • Self-reviewed the diff

@carbolymer carbolymer force-pushed the mgalazyn/chore/fix-haddocks-gha branch 4 times, most recently from fdf1b4d to 8208c92 Compare September 13, 2023 14:29
.github/bin/haddocs.sh Outdated Show resolved Hide resolved
@carbolymer carbolymer force-pushed the mgalazyn/chore/fix-haddocks-gha branch 2 times, most recently from ddc9b52 to 6d16b89 Compare September 14, 2023 07:39
@carbolymer carbolymer marked this pull request as ready for review September 14, 2023 07:40
@smelc smelc mentioned this pull request Sep 14, 2023
.github/bin/haddocs.sh Outdated Show resolved Hide resolved
.github/bin/haddocs.sh Outdated Show resolved Hide resolved
.github/bin/haddocs.sh Outdated Show resolved Hide resolved
@smelc
Copy link
Contributor

smelc commented Sep 14, 2023

When running the script locally, it fails with:

Error: cabal: Failed to build documentation for set-algebra-1.1.0.1 (which is
required by lib:gen from cardano-api-8.20.0.0).

I suspect it's not an issue of this PR, but is there a way I could test the end of the script? (since it's the early cabal haddock call that fails 🙁).

@carbolymer
Copy link
Contributor Author

@smelc you can try to follow the steps in github-page.yml to generate haddocks.

@newhoggy
Copy link
Collaborator

Could be worthwhile converting this into a re-usable Github Action

@carbolymer carbolymer force-pushed the mgalazyn/chore/fix-haddocks-gha branch from 6d16b89 to 3096bbe Compare September 14, 2023 10:04
@carbolymer carbolymer added this pull request to the merge queue Sep 14, 2023
Merged via the queue into main with commit 22e2b29 Sep 14, 2023
21 checks passed
@carbolymer carbolymer deleted the mgalazyn/chore/fix-haddocks-gha branch September 14, 2023 11:01
newhoggy added a commit that referenced this pull request Mar 11, 2024
…-address-command-group

Era-based `stake-address` command group
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.

[FR] - Haddock link
3 participants