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 - now using nix #445

Merged
merged 1 commit into from
Jul 9, 2024

Conversation

carbolymer
Copy link
Contributor

@carbolymer carbolymer commented Nov 10, 2023

Changelog

- description: |
    Fix haddocks generation - now using nix
# 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

Fixes the same issue which happened in cardano-api repo:

This PR copies changes from cardano-api from:

Sample workflow run with generated haddocks (attached as an artifact): https://github.com/IntersectMBO/cardano-cli/actions/runs/9796004207

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/fix-haddocks-references branch 5 times, most recently from 2f83a2f to f35cbfd Compare November 16, 2023 11:47
@carbolymer
Copy link
Contributor Author

carbolymer commented Nov 21, 2023

FIXME:

  • generated haddocks contain only docs for the tests - docs for library and exe are missing

@smelc
Copy link
Contributor

smelc commented Dec 12, 2023

@andreabedini> would you have a clue why this PR only produces haddocks for tests (see @carbolymer's comment above: #445 (comment))?

@carbolymer carbolymer force-pushed the mgalazyn/chore/fix-haddocks-references branch 4 times, most recently from 134efea to c084594 Compare December 12, 2023 17:20
@andreabedini
Copy link
Contributor

@andreabedini> would you have a clue why this PR only produces haddocks for tests (see @carbolymer's comment above: #445 (comment))?

It looks like they are created but somehow only the tests (the ones created last) make it into the index.

@carbolymer carbolymer force-pushed the mgalazyn/chore/fix-haddocks-references branch 3 times, most recently from 7e6791b to 2dd75a3 Compare December 13, 2023 10:25

This comment was marked as spam.

This comment was marked as spam.

@carbolymer
Copy link
Contributor Author

carbolymer commented Mar 26, 2024

This comment was marked as spam.

This comment was marked as spam.

@github-actions github-actions bot added the Stale label Jul 1, 2024
@carbolymer carbolymer removed the Stale label Jul 1, 2024
@carbolymer carbolymer force-pushed the mgalazyn/chore/fix-haddocks-references branch 2 times, most recently from ccffed0 to 58df2d0 Compare July 4, 2024 14:16
@carbolymer carbolymer force-pushed the mgalazyn/chore/fix-haddocks-references branch from 58df2d0 to 97a42e1 Compare July 4, 2024 14:22
@carbolymer carbolymer force-pushed the mgalazyn/chore/fix-haddocks-references branch from 97a42e1 to aeff309 Compare July 4, 2024 15:44
@carbolymer carbolymer marked this pull request as ready for review July 4, 2024 15:45
@carbolymer carbolymer changed the title Fix haddocks references to libraries Fix haddocks generation - now using nix Jul 4, 2024
Copy link
Contributor

@Jimbo4350 Jimbo4350 left a comment

Choose a reason for hiding this comment

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

LGTM however I'm not seeing the haddocks action in the summary.

Comment on lines +45 to +46
nix develop .\#haddockShell --command \
cabal haddock-project --output=./haddocks --internal --foreign-libraries
Copy link
Contributor

Choose a reason for hiding this comment

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

😄 🎉

@carbolymer carbolymer added this pull request to the merge queue Jul 9, 2024
Merged via the queue into main with commit 3391884 Jul 9, 2024
24 checks passed
@carbolymer carbolymer deleted the mgalazyn/chore/fix-haddocks-references branch July 9, 2024 09:58
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.

5 participants