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

Remove consensus internal options from cli flags #5813

Merged
merged 1 commit into from
May 27, 2024

Conversation

jasagredo
Copy link
Contributor

@jasagredo jasagredo commented Apr 29, 2024

Description

Some of the options presented as cli flags seem to be consensus internal or low-level options. This PR adds warnings when they are set via cli flags in preparation for future removal, they can still be configured in the JSON/YAML configuration.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. These may include:
    • golden tests
    • property tests
    • roundtrip tests
    • integration tests
      See Runnings tests for more details
  • Any changes are noted in the CHANGELOG.md for affected package
  • 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

@jasagredo jasagredo requested a review from a team as a code owner April 29, 2024 09:13
@jasagredo jasagredo force-pushed the js/remove-cli-args branch from fc3c419 to c3276d8 Compare April 29, 2024 09:19
@mgmeier
Copy link
Contributor

mgmeier commented Apr 29, 2024

For Performance & Tracing: we do make use of the snapshot options only via the --config file. We don't require them as CLI options.

@jasagredo jasagredo requested review from a team as code owners April 29, 2024 10:21
@jasagredo jasagredo self-assigned this Apr 30, 2024
@jasagredo jasagredo force-pushed the js/remove-cli-args branch from 84a3380 to 2d77caa Compare April 30, 2024 14:06
@jasagredo jasagredo force-pushed the js/remove-cli-args branch from bb9d542 to 3d22d38 Compare May 16, 2024 09:55
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! Updating the parser help with the configuration value needed to set in the config file would be useful.

@jasagredo jasagredo force-pushed the js/remove-cli-args branch from 3d22d38 to 305d328 Compare May 27, 2024 12:39
@jasagredo jasagredo enabled auto-merge May 27, 2024 12:40
@jasagredo jasagredo added this pull request to the merge queue May 27, 2024
Merged via the queue into master with commit 9ed9aca May 27, 2024
24 checks passed
@jasagredo jasagredo deleted the js/remove-cli-args branch May 27, 2024 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

4 participants