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

Update to asdf 0.8.0 plugin API #24

Open
jthegedus opened this issue Sep 2, 2020 · 0 comments
Open

Update to asdf 0.8.0 plugin API #24

jthegedus opened this issue Sep 2, 2020 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@jthegedus
Copy link
Owner

Is your feature request related to a problem? Please describe.

asdf 0.8.0 has support for documentation callbacks https://asdf-vm.com/#/plugins-create?id=optional-scripts

  • bin/help.overview - This script should output a general description about the plugin and the tool being managed. No heading should be printed as asdf will print headings. Output may be free-form text but ideally only one short paragraph. This script must be present if you want asdf to provide help information for your plugin. All other help callback scripts are optional.
  • bin/help.deps - This script should output the list of dependencies tailored to the operating system. One dependency per line.
  • bin/help.config - This script should print any required or optional configuration that may be available for the plugin and tool. Any environment variables or other flags needed to install or compile the tool (for the users operating system when possible). Output can be free-form text.
  • bin/help.links - This should be a list of links relevant to the plugin and tool (again, tailored to the current operating system when possible). One link per line. Lines may be in the format <title>: or just .

Describe the solution you'd like

Implement these scripts

Describe alternatives you've considered

Additional context

Might have to rethink existing solutions to deps etc.

@jthegedus jthegedus added the enhancement New feature or request label Sep 2, 2020
@jthegedus jthegedus self-assigned this Sep 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant