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

Ch/clearer anchor flags #372

Merged
merged 4 commits into from
Oct 13, 2023
Merged

Ch/clearer anchor flags #372

merged 4 commits into from
Oct 13, 2023

Conversation

carlhammann
Copy link
Contributor

@carlhammann carlhammann commented Oct 12, 2023

Changelog

- description: |
    Clearer command line flags for vote, proposal, and constitution anchors
# 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

On #362, we started a discussion about how the various anchor-related flags could be named in a less confusing manner. This PR implements an idea that we settled upon after a short discussion: Anchors for an x are given by an --x-anchor-url together with one of the following three:

  • --x-anchor-metadata for the literal data behind the URL,
  • --x-anchor-metadata-file for a file containing the same data, or
  • --x-anchor-metadata-hash for the hash of the data.

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
  • Self-reviewed the diff

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 couple of minor changes.

@carlhammann carlhammann force-pushed the ch/clearer-anchor-flags branch from effbd69 to 2c0a157 Compare October 13, 2023 12:43
@carlhammann carlhammann enabled auto-merge October 13, 2023 12:44
@carlhammann carlhammann added this pull request to the merge queue Oct 13, 2023
Merged via the queue into main with commit 332351d Oct 13, 2023
@carlhammann carlhammann deleted the ch/clearer-anchor-flags branch October 13, 2023 13:27
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.

2 participants