Skip to content

Commit

Permalink
Add README.md and initial files (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
derekbekoe authored Oct 11, 2017
1 parent d5049fa commit 950dd97
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# See for instructions on this file https://help.github.com/articles/about-codeowners/

index.json @derekbekoe

9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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)

-----

4 changes: 4 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@


-----

31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Empty file added index.json
Empty file.

0 comments on commit 950dd97

Please sign in to comment.