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

Create ASDF Scripts for Popular Cosmos Binaries #1

Open
danbryan opened this issue Aug 25, 2024 · 0 comments
Open

Create ASDF Scripts for Popular Cosmos Binaries #1

danbryan opened this issue Aug 25, 2024 · 0 comments

Comments

@danbryan
Copy link
Contributor

danbryan commented Aug 25, 2024

Title: Create ASDF Scripts for Popular Cosmos Binaries

Description:

Objective:
Develop ASDF scripts to streamline the installation and management of popular Cosmos binaries. The goal is to make it easy for developers to install and switch between different versions of Cosmos chain binaries using ASDF.

Background:
ASDF is a version manager that allows developers to easily install and manage different versions of binaries. By creating ASDF plugins for Cosmos binaries, users can quickly set up their development environment with the specific versions they need. The plugin should support multiple Cosmos binaries, pulling information from existing repositories to ensure accuracy and ease of use.

Tasks:

  1. Repository Setup:

    • Create a new repository under the Defiantlabs GitHub organization named cosmos-asdf-plugins.
    • Structure the repository to house ASDF plugin scripts for multiple Cosmos binaries.
  2. ASDF Plugin Development:

    • Develop ASDF plugins for popular Cosmos binaries. The UX should follow this flow:
      asdf plugin repo add cosmo-bins https://github.com/Defiantlabs/cosmos-asdf-plugins
      asdf plugin add <binary-name>
      asdf install <binary-name> <version>
    • Each plugin should:
      • Retrieve the binary from the appropriate source.
      • Support installation of multiple versions.
      • Integrate seamlessly with the ASDF version management system.
  3. Source Information Retrieval:

    • Use the Heighliner chains.yaml and the Cosmos chain registry to gather GitHub information, download URLs, and versioning details for each chain's binary.
    • Ensure that the plugins are kept up-to-date with the latest binaries and versions available in these repositories.
  4. Testing:

    • Test each ASDF plugin to ensure it correctly installs the binaries, handles different versions, and integrates well with the ASDF tool.
    • Include edge case testing, such as handling installation failures, unsupported versions, and plugin updates.
  5. Documentation:

    • Document the usage of each ASDF plugin, including how to add the plugin, install binaries, switch between versions, and troubleshoot common issues.
    • Provide a README.md file in the cosmos-asdf-plugins repository detailing the setup process and available plugins.
  6. Community Feedback:

    • After initial implementation, gather feedback from the Cosmos community to identify additional binaries to support and any improvements needed for the plugins.

Resources:

Acceptance Criteria:

  • ASDF plugins are available for multiple popular Cosmos binaries.
  • The plugins are fully tested, documented, and function seamlessly with ASDF.
  • Users can easily add the cosmo-bins plugin repository, install binaries, and switch between versions.
@danbryan danbryan changed the title Create ASDF scripts for all cosmos chains automatically Create ASDF Scripts for Popular Cosmos Binaries Aug 25, 2024
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

No branches or pull requests

1 participant