Skip to content

Commit

Permalink
{Doc} Refine extension release notes (Azure#1884)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jianhui Harold authored Jun 16, 2020
1 parent 06e33d2 commit be1cc53
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,18 @@ Add your extension to the index to make it available in these CLI commands:
- 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.

## About extension publishing

There is a pipeline to automatically build, upload and publish extension wheels.

Once your PR is merged into master branch, a new PR will be created to update `src/index.json` automatically.

The precondition is to put your code inside this repo and upgrade the version in the PR but not to modify `src/index.json`.

If you want to host the source code in your dedicated repo, you have to upload the WHL file and update the `src/index.json` manually.

For detail, please visit [Publish section in Azure CLI Extension Authoring](https://github.com/Azure/azure-cli/blob/dev/doc/extensions/authoring.md#publish).

## FAQ

### How to generate sha256digest for an index.json entry?
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Doc Sections

- [Command Guidelines](https://github.com/Azure/azure-cli/blob/dev/doc/command_guidelines.md) - Command Guidelines

- [Publishing](https://github.com/Azure/azure-cli/blob/dev/doc/extensions/publishing.md) - How to publish an extension
- [Publishing](https://github.com/Azure/azure-cli/blob/dev/doc/extensions/authoring.md#publish) - How to publish an extension

- [Summary Guidelines](https://github.com/Azure/azure-cli/blob/dev/doc/extensions/extension_summary_guidelines.md) - Summary guidelines for extensions to be published

Expand Down

0 comments on commit be1cc53

Please sign in to comment.