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

Automation to detect new Kubo commands #47

Open
lidel opened this issue Oct 14, 2022 · 0 comments
Open

Automation to detect new Kubo commands #47

lidel opened this issue Oct 14, 2022 · 0 comments
Labels
need/triage Needs initial labeling and prioritization

Comments

@lidel
Copy link
Member

lidel commented Oct 14, 2022

This client library's repo should proactively detect when a new Kubo release introduces a new RPC command.

Example: /api/v0/repo/ls was introduced in ipfs/kubo#9320
As a bare minimum, an issue should be opened in this repo when Kubo 0.17 ships and this library does not support repo.ls.

Implementation tips

  • DETECTING NEW COMMANDS
    • /api/v0/commands / ipfs commands --enc=json is a way to output all commands supported by Kubo build.
    • CI job should read commands, skip ignored ones, and error if there are any new commands that are not implemented by this client library
  • IGNORE LIST
    • kubo-rpc-client library should have a list of ignored commands that we can't or don't plan to implement
    • e.g., /api/v0/shutdown, /api/v0/key/rotate, any missing things from https://docs.ipfs.tech/reference/kubo/rpc/#deprecated-rpc-commands should be marked as things we dont plan to implement (allowing us to focus on truly useful commands)
  • DETECTING NEW KUBO RELEASE
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need/triage Needs initial labeling and prioritization
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant