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

Use latest cabal master for haddocks generation. Fix broken haddocks. #577

Merged
merged 1 commit into from
Jul 4, 2024

Conversation

carbolymer
Copy link
Contributor

@carbolymer carbolymer commented Jul 3, 2024

Changelog

- description: |
    Use latest cabal master for haddocks generation. Fix broken haddocks.
# 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
  # - refactoring    # QoL changes
  # - 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

Use latest cabal master for haddocks generation.
Fixes #437
Fixes #546

Sample workflow run with generated haddocks: https://github.com/IntersectMBO/cardano-api/actions/runs/9778593657

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. See Running tests for more details
  • Self-reviewed the diff

@carbolymer carbolymer force-pushed the mgalazyn/chore/update-cabal-for-haddocks branch 5 times, most recently from 66748ce to dca8b6e Compare July 3, 2024 13:15
@carbolymer carbolymer force-pushed the mgalazyn/chore/update-cabal-for-haddocks branch from dca8b6e to 724dd3e Compare July 3, 2024 14:13
@carbolymer carbolymer marked this pull request as ready for review July 3, 2024 14:15
@carbolymer carbolymer requested review from Jimbo4350, newhoggy, smelc, palas and a team as code owners July 3, 2024 14:15
@carbolymer carbolymer changed the title Try latest cabal for haddocks Use latest cabal master for haddocks generation. Fix broken haddocks. Jul 3, 2024
@@ -43,7 +43,7 @@ jobs:
- name: Build documentation
run: |
nix develop .\#haddockShell --command \
cabal haddock-project --local --output=./haddocks --internal --foreign-libraries
Copy link

Choose a reason for hiding this comment

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

why remove --local?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This command line argument is not present anymore in the latest cabal master.

@smelc
Copy link
Contributor

smelc commented Jul 3, 2024

@carbolymer> can we test the behavior before merging? (building locally?)

@carbolymer
Copy link
Contributor Author

@smelc I've enabled for the development the workflow on a branch, and you can see the results there: https://github.com/IntersectMBO/cardano-api/actions/runs/9778593657
There's an artifact which contains generated haddocks.

@carbolymer carbolymer added this pull request to the merge queue Jul 4, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Jul 4, 2024
@carbolymer carbolymer merged commit a3c24ef into main Jul 4, 2024
27 of 28 checks passed
@carbolymer carbolymer deleted the mgalazyn/chore/update-cabal-for-haddocks branch July 4, 2024 10:54
@carbolymer
Copy link
Contributor Author

carbolymer commented Jul 4, 2024

github-merge-queue bot removed this pull request from the merge queue due to no response for status checks

CI is green, so force merging.

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.

[BUG] - http 404 from cardano-api doc site [BUG] - haddocks for public library modules are missing
3 participants