From 5a2e69ca862eead8655470668c252513b38caebd Mon Sep 17 00:00:00 2001 From: Marcos Ferreira Date: Wed, 24 Oct 2018 19:20:13 -0300 Subject: [PATCH] Add info about using the CI repo on plugin test --- docs/creating-plugins.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/creating-plugins.md b/docs/creating-plugins.md index 825cfba4..bfbba297 100644 --- a/docs/creating-plugins.md +++ b/docs/creating-plugins.md @@ -137,7 +137,7 @@ Here is a sample `.travis.yml` file, customize it to your needs ```yaml language: c -script: asdf plugin-test nodejs https://github.com/asdf-vm/asdf-nodejs.git 'node --version' +script: asdf plugin-test nodejs $TRAVIS_BUILD_DIR 'node --version' before_script: - git clone https://github.com/asdf-vm/asdf.git asdf - . asdf/asdf.sh @@ -146,6 +146,14 @@ os: - osx ``` +Note: +When using another CI, you will need to check what variable maps to the repo path. + +You also have the option to pass a relative path to `plugin-test`. + +For example, if the test script is ran in the repo directory: `asdf plugin-test nodejs . 'node --version'`. + + ## GitHub API Rate Limiting If your plugin's `list-all` depends on accessing the GitHub API, make sure you provide