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 references to libraries #363

Merged
merged 1 commit into from
Nov 16, 2023

Conversation

carbolymer
Copy link
Contributor

@carbolymer carbolymer commented Nov 10, 2023

Changelog

- description: |
    Fix haddocks references to libraries. Use nix for building 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
  # - 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

Previously links to other libraries e.g. base were broken. This PR replaces CI pipeline and custom script for building and publishing haddocks with nix-based pipeline.

Output: https://input-output-hk.github.io/cardano-api/

Sample pipeline run: https://github.com/input-output-hk/cardano-api/actions/runs/6888403096

How to trust this PR

Highlight important bits of the PR that will make the review faster. If there are commands the reviewer can run to observe the new behavior, describe them.

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 3 times, most recently from fa1a5cf to 1900d1b Compare November 16, 2023 08:53
@carbolymer carbolymer force-pushed the mgalazyn/chore/fix-haddocks-references branch from 1900d1b to 9533fcf Compare November 16, 2023 09:45
@carbolymer carbolymer marked this pull request as ready for review November 16, 2023 09:46
@carbolymer carbolymer added this pull request to the merge queue Nov 16, 2023
Merged via the queue into main with commit 74fe801 Nov 16, 2023
21 checks passed
@carbolymer carbolymer deleted the mgalazyn/chore/fix-haddocks-references branch November 16, 2023 15:46
newhoggy pushed a commit that referenced this pull request Mar 11, 2024
…d-test

Add test of voting using a cc hot key
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.

4 participants