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.

Sign up for GitHub

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

{Doc} Refine extension release notes #1884

Merged
merged 5 commits into from
Jun 16, 2020
Merged

{Doc} Refine extension release notes #1884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
be471d4
fix 404 link
Jun 15, 2020
d30bf5d
refine docs about publish
Jun 15, 2020
e9f6936
Update README.md
Jun 15, 2020
c7b457f
Update README.md
Jun 15, 2020
1e4122d
Update README.md
Jun 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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