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

Feat: one line installation script for Mithril nodes #2136

Merged
merged 7 commits into from
Nov 25, 2024

Conversation

jpraynaud
Copy link
Member

@jpraynaud jpraynaud commented Nov 22, 2024

Content

This PR includes an installation script for Mithril nodes which will hopefully help achieve a better adoption of the latest releases. A one line command has also been added in the pre-built binary installation sections of the pages of the documentation.

New installation script

  • mithril-install.sh: Added a new script to install or upgrade Mithril nodes. The script supports different nodes (mithril-signer, mithril-aggregator, mithril-client), distributions (latest, unstable, specific versions), and installation paths. It includes error handling and validation for operating systems and architectures.

Note

Before the PR is merged the installation script can be tested with this command:
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/input-output-hk/mithril/refs/heads/jpraynaud/2034-install-script-mithril-nodes/mithril-install.sh | sh -s -- -c mithril-signer -d latest -p $(pwd)

Documentation updates

  • docs/website/root/compiled-binaries.md: Removed outdated content and converted the file to MDX format.
  • Updated multiple documentation files to reference compiled-binaries.mdx instead of compiled-binaries.md. This includes files related to Mithril nodes and getting started guides.

Pre-submit checklist

  • Branch
    • CHANGELOG file is updated (if relevant)
    • 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
  • Documentation
    • Update documentation website (if relevant)

Issue(s)

Relates to #2034

@jpraynaud jpraynaud self-assigned this Nov 22, 2024
Copy link

github-actions bot commented Nov 22, 2024

Test Results

    4 files     51 suites   11m 42s ⏱️
1 455 tests 1 455 ✅ 0 💤 0 ❌
1 666 runs  1 666 ✅ 0 💤 0 ❌

Results for commit d75ab71.

♻️ This comment has been updated with latest results.

Copy link
Collaborator

@sfauvel sfauvel left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@dlachaume dlachaume left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Copy link
Collaborator

@Alenar Alenar left a comment

Choose a reason for hiding this comment

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

LGTM 🔥

mithril-install.sh Outdated Show resolved Hide resolved
@jpraynaud jpraynaud force-pushed the jpraynaud/2034-install-script-mithril-nodes branch from e4b6f9a to d75ab71 Compare November 22, 2024 16:48
@jpraynaud jpraynaud temporarily deployed to testing-sanchonet November 22, 2024 17:05 — with GitHub Actions Inactive
@jpraynaud jpraynaud merged commit dfb1eea into main Nov 25, 2024
50 checks passed
@jpraynaud jpraynaud deleted the jpraynaud/2034-install-script-mithril-nodes branch November 25, 2024 08:52
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