IntersectMBO / cardano-cli

This repository contains sources for the command-line interface (CLI) tool for interacting with the Cardano blockchain.
Apache License 2.0
37 stars 13 forks source link

Cl/descriptions #747

Closed CarlosLopezDeLara closed 4 months ago

CarlosLopezDeLara commented 4 months ago

Changelog

- description: |
    Include an informative description of the type of action in the governance action (proposal) file. 
# 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

Before this PR governance action files did not include a description:

{
    "type": "Governance proposal",
    "description": "",
    "cborHex": "841b0000000ba43b7400581de008f121b36abf2bcdd7daa2551c1e6653413a78c419e170d3319924d38400f6a112a1029f1a0003236119032c01011903e819023b00011903e8195e7104011903e818201a0001ca761928eb041959d818641959d818641959d818641959d818641959d818641959d81864186418641959d81864194c5118201a0002acfa182019b551041a000363151901ff00011a00015c3518201a000797751936f404021a0002ff941a0006ea7818dc0001011903e8196ff604021a0003bd081a00034ec5183e011a00102e0f19312a011a00032e801901a5011a0002da781903e819cf06011a00013a34182019a8f118201903e818201a00013aac0119e143041903e80a1a00030219189c011a00030219189c011a0003207c1901d9011a000330001901ff0119ccf3182019fd40182019ffd5182019581e18201940b318201a00012adf18201a0002ff941a0006ea7818dc0001011a00010f92192da7000119eabb18201a0002ff941a0006ea7818dc0001011a0002ff941a0006ea7818dc0001011a0011b22c1a0005fdde00021a000c504e197712041a001d6af61a0001425b041a00040c660004001a00014fab18201a0003236119032c010119a0de18201a00033d7618201979f41820197fb8182019a95d1820197df718201995aa18201a0218f4f50a1a0374f693194a1f0a1a0254f375197e040a1959d818641959d818641a000cb528121a0030f786061a00050ebb011a03eef01c195a39121a0001be42121a05a0543f1a00015414121a00fa8cf9121a0020be0618241a0039e9910c1a000d90bf011a0c2c69e2195ae718241a0001f88d18241a0b52d4be1a00014f8e18241a01f7bc8018241a17272ce0011a17f44a4118481a002392f318481a001d6af61a0001425b041a0001ca761928eb041a0013b72b195f95184a00011a000e48dd19c1c118ed0001fff682784f68747470733a2f2f6769746875622e636f6d2f6361726c6f736c6f64656c61722f70726f706f73616c732f626c6f622f6d61696e2f7768792d706c7574757376332d636f73746d6f64656c2e747874582006dbd5cdbb8b4e684c0be1bf67524f5afdf8fe0e70e3c9857b6c2fc49a0ce9d2"
}

After this PR, the produced file includes a description

{
    "type": "Governance proposal",
    "description": "Update protocol parameters proposal",
    "cborHex": "841b0000000ba43b7400581de008f121b36abf2bcdd7daa2551c1e6653413a78c419e170d3319924d38400f6a112a1029f1a0003236119032c01011903e819023b00011903e8195e7104011903e818201a0001ca761928eb041959d818641959d818641959d818641959d818641959d818641959d81864186418641959d81864194c5118201a0002acfa182019b551041a000363151901ff00011a00015c3518201a000797751936f404021a0002ff941a0006ea7818dc0001011903e8196ff604021a0003bd081a00034ec5183e011a00102e0f19312a011a00032e801901a5011a0002da781903e819cf06011a00013a34182019a8f118201903e818201a00013aac0119e143041903e80a1a00030219189c011a00030219189c011a0003207c1901d9011a000330001901ff0119ccf3182019fd40182019ffd5182019581e18201940b318201a00012adf18201a0002ff941a0006ea7818dc0001011a00010f92192da7000119eabb18201a0002ff941a0006ea7818dc0001011a0002ff941a0006ea7818dc0001011a0011b22c1a0005fdde00021a000c504e197712041a001d6af61a0001425b041a00040c660004001a00014fab18201a0003236119032c010119a0de18201a00033d7618201979f41820197fb8182019a95d1820197df718201995aa18201a0218f4f50a1a0374f693194a1f0a1a0254f375197e040a1959d818641959d818641a000cb528121a0030f786061a00050ebb011a03eef01c195a39121a0001be42121a05a0543f1a00015414121a00fa8cf9121a0020be0618241a0039e9910c1a000d90bf011a0c2c69e2195ae718241a0001f88d18241a0b52d4be1a00014f8e18241a01f7bc8018241a17272ce0011a17f44a4118481a002392f318481a001d6af61a0001425b041a0001ca761928eb041a0013b72b195f95184a00011a000e48dd19c1c118ed0001fff682784f68747470733a2f2f6769746875622e636f6d2f6361726c6f736c6f64656c61722f70726f706f73616c732f626c6f622f6d61696e2f7768792d706c7574757376332d636f73746d6f64656c2e747874582012dc042f01030f0c6d894328b8e0635117c838e516f71f1317af7460509eb4fa"
}

How to trust this PR

Tests have been updated and all are Passing.

Checklist