diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 00000000000..bd090e10614 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,4 @@ +# See for instructions on this file https://help.github.com/articles/about-codeowners/ + +index.json @derekbekoe + diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000000..f1efcc2f1ab --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,9 @@ +- If the issue is to do with Azure CLI 2.0 in-particular, create an issue here at [Azure/azure-cli](https://github.com/Azure/azure-cli/issues) + +### Extension name (the extension in question) + + +### Description of issue (in as much detail as possible) + +----- + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000000..eb37fc6574c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,4 @@ + + +----- + diff --git a/README.md b/README.md index 72f1506a93b..7db837dd74d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,35 @@ +# Extensions for Azure CLI 2.0 + +This repository serves two purposes and they are independent: + +1. An `index.json` where you can add your extension and make it available through Azure CLI. +2. A source code directory, `src`, to host your extension source code. + +For documentation on authoring an extension, see [Extension Documentation](https://github.com/Azure/azure-cli/tree/master/doc/extensions) + +## About index.json + +- Modify the index by creating a PR. +- All extensions added to the index *are public* and will be available to *all* CLI users. +- Your extension source code does not have to be in this repository to be available in the index. +- If you don't want your extension to be part of the index, you can still host it externally and request users to install with `az extension add --source https://contoso.com/mywheel.whl`. + * Users will not be able to add your extension by name, it will not be listed in the `az extension list-available` command and to update to a new version of your extension, the user has to first remove the currently installed extension and then add the new version. + +Add your extension to the index to make it available in these CLI commands: +- `az extension add --name NAME` - Allows users to add an extension by name +- `az extension list-available` - Allows users to list the available extensions in the index +- `az extension update --name NAME` - Allows users to update an extension + +## About source code in this repository + +- Extension source code goes into the `src` directory. +- You can place your source code in this repository by creating a PR. +- Once CI is green and it has been approved, the PR can be merged. +- Ensure that you include an appropriate owner for your extension in `.github/CODEOWNERS`. +- Your extension artifact (i.e. `.whl`) will not live in this repository. You can publish your extension to PyPI or somewhere else such as Azure Storage. +- If you want your extension to appear in the index.json, modify the index. + # Contributing This project welcomes contributions and suggestions. Most contributions require you to agree to a diff --git a/index.json b/index.json new file mode 100644 index 00000000000..e69de29bb2d