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

Make transaction view emit JSON #319

Merged
merged 5 commits into from
Oct 9, 2023
Merged

Conversation

carlhammann
Copy link
Contributor

Changelog

- description: |
    Make `cardano-cli * transaction view` output JSON by default.
# 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

We discussed here that cardano-cli should output JSON by default. The transaction view commands currently write YAML. This PR makes it so that YAML is only emitted by these commands with the option --output-format yaml. I also added an --out-file option to redirect the output to some file instead of stdout.

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

@carlhammann carlhammann force-pushed the ch/transaction-view-json branch from 5f50e6b to 8b293df Compare October 9, 2023 09:19
@carlhammann carlhammann enabled auto-merge October 9, 2023 09:20
@carlhammann carlhammann added this pull request to the merge queue Oct 9, 2023
Merged via the queue into main with commit eae2bb9 Oct 9, 2023
19 checks passed
@carlhammann carlhammann deleted the ch/transaction-view-json branch October 9, 2023 09:47
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.

3 participants