From 3d926d619e2a739620073a8708e1e2f0036bf270 Mon Sep 17 00:00:00 2001 From: Travis Prescott Date: Wed, 20 Feb 2019 10:40:50 -0800 Subject: [PATCH] Update README.md (#510) * Update README.md Add references to `azdev extension update-index` command. * Code review feedback. * Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 6a181b49946..aea0c95567d 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,10 @@ Add your extension to the index to make it available in these CLI commands: ### How to generate sha256digest for an index.json entry? +If you use `azdev extension update-index` the command will calculate the SHA256 digest for you. For more information visit https://github.com/Azure/azure-cli-dev-tools. + +As a fallback: + MacOS ``` shasum -a 256 path_to_whl.whl @@ -51,6 +55,10 @@ Note: Hash should be in lowercase in index.json otherwise CI will fail. ### How to fill in the metadata for an index.json entry? +The `azdev extension update-index` command can be used to simplify the process of updating the index file. Run `azdev extension update-index ` where URL is the fully-qualified URL to your published extension WHL. This will gather the appropriate metadata and add an entry for your extension to the index. For more information visit https://github.com/Azure/azure-cli-dev-tools. + +As a fallback: + The metadata needed to be filled is a combination of the contents present in: - `metadata.json` located in your unzipped extension artifact (`.whl` file) in the `-.dist-info` directory. This metadata is garnered from the `setup.py` folder. - `azext_metadata.json` (if it exists) under your extension.