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 all hardcoded yaml files from cardano-testnet #5242

Merged
merged 4 commits into from
May 18, 2023

Conversation

Jimbo4350
Copy link
Contributor

@Jimbo4350 Jimbo4350 commented May 12, 2023

Description

Hardcoding configuration files makes cardano-testnet less portable and also introduces ambiguity into what your node configuration actually is.

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

Note on CI

If your PR is from a fork, the necessary CI jobs won't trigger automatically for security reasons.
You will need to get someone with write privileges. Please contact IOG node developers to do this
for you.

@Jimbo4350 Jimbo4350 force-pushed the jordan/remove-hardcoded-yaml-files branch from fe2e545 to 305bbc5 Compare May 15, 2023 16:09
@Jimbo4350 Jimbo4350 marked this pull request as ready for review May 15, 2023 16:15
@@ -14,10 +14,12 @@ module Testnet.Babbage
, babbageTestnet
) where

import Cardano.Api
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

import Data.Word
import GHC.Stack
import Options.Applicative
import System.Directory (doesFileExist, removeFile)

import Cardano.Chain.Genesis (GenesisHash (unGenesisHash), readGenesisData)

import qualified Cardano.Crypto.Hash.Blake2b as Crypto
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor Author

@Jimbo4350 Jimbo4350 May 15, 2023

Choose a reason for hiding this comment

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

Made changes but opened a PR to suggest an update to the style doc.

@newhoggy
Copy link
Contributor

This is good, but I think we should write the default yaml file to a golden file as well so the configuration file can easily be reviewed or read by non-coders.

@Jimbo4350 Jimbo4350 force-pushed the jordan/remove-hardcoded-yaml-files branch from 4cfad69 to 16d4130 Compare May 18, 2023 16:54
@Jimbo4350
Copy link
Contributor Author

This is good, but I think we should write the default yaml file to a golden file as well so the configuration file can easily be reviewed or read by non-coders.

Done 👍

@Jimbo4350 Jimbo4350 enabled auto-merge May 18, 2023 16:57
@Jimbo4350 Jimbo4350 added this pull request to the merge queue May 18, 2023
Merged via the queue into master with commit 181c038 May 18, 2023
@iohk-bors iohk-bors bot deleted the jordan/remove-hardcoded-yaml-files branch May 18, 2023 17:57
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