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

Docs: enhance era markers runbook #2033

Merged
merged 1 commit into from
Oct 22, 2024

Conversation

jpraynaud
Copy link
Member

@jpraynaud jpraynaud commented Oct 21, 2024

Content

This pull request includes extensive updates to the docs/runbook/era-markers/README.md to improve clarity and ensure proper configuration for managing Mithril activation eras on the Cardano chain. The changes focus on enhancing the documentation format, updating environment variables, and providing detailed steps for setting up, bootstrapping, and updating era markers.

Documentation Improvements:

  • Enhanced warning format for critical steps using [!IMPORTANT] and :fire: to emphasize potential risks. [1] [2]
  • Added detailed instructions for setting up environment variables, including examples for both testnet and mainnet configurations.

Environment Configuration:

  • Introduced new environment variables such as CARDANO_CLI, SCRIPT_TX_VALUE, and CARDANO_NETWORK_MAGIC to streamline the setup process.
  • Updated commands to use the new CARDANO_CLI variable for consistency across the documentation. [1] [2]

Era Markers Management:

  • Provided separate sections and detailed steps for preparing era markers, including handling single and multiple supported eras.
  • Added verification steps to ensure the produced era markers are accurate and as expected.

Transaction Handling:

  • Updated transaction commands to include --socket-path and use the new environment variables for better clarity and accuracy. [1] [2]
  • Clarified the process for creating and submitting transactions, including retrieving transaction IDs and verifying UTxO states. [1] [2]

Pre-submit checklist

  • Branch
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • No clippy warnings in the CI
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested

Issue(s)

Relates to #1946

@jpraynaud jpraynaud self-assigned this Oct 21, 2024
Copy link

github-actions bot commented Oct 21, 2024

Test Results

    4 files  ±0     55 suites  ±0   10m 31s ⏱️ +5s
1 379 tests ±0  1 379 ✅ ±0  0 💤 ±0  0 ❌ ±0 
1 593 runs  ±0  1 593 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 01892ea. ± Comparison against base commit ef8c283.

♻️ This comment has been updated with latest results.

@jpraynaud jpraynaud force-pushed the jpraynaud/1946-enhance-rera-marker-runbook branch from b31b956 to 6116b06 Compare October 21, 2024 16:40
docs/runbook/era-markers/README.md Outdated Show resolved Hide resolved
@jpraynaud jpraynaud force-pushed the jpraynaud/1946-enhance-rera-marker-runbook branch from 6116b06 to 01892ea Compare October 22, 2024 10:04
@jpraynaud jpraynaud merged commit cef78f0 into main Oct 22, 2024
48 checks passed
@jpraynaud jpraynaud deleted the jpraynaud/1946-enhance-rera-marker-runbook branch October 22, 2024 11:23
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.

4 participants