IntersectMBO / cardano-api

Cardano API
Apache License 2.0
22 stars 20 forks source link

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

Closed carbolymer closed 2 months ago

carbolymer commented 2 months ago

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 https://github.com/IntersectMBO/cardano-api/issues/437 Fixes https://github.com/IntersectMBO/cardano-api/issues/546

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

Checklist

smelc commented 2 months ago

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

carbolymer commented 2 months ago

@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 commented 2 months ago

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.