Skip to content

{docs} docs template for extension #3311

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

Merged
msyyc merged 6 commits into from
May 14, 2021
Merged

{docs} docs template for extension #3311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6c2ea71
docs template for extension
msyyc Apr 28, 2021
e41e8a8
review
msyyc May 12, 2021
2a75d24
pylint
msyyc May 12, 2021
c9f20cc
review
msyyc May 13, 2021
d2411c2
Update scripts/ci/avail-ext-doc/list-template.md
msyyc May 14, 2021
76f6b23
Merge branch 'master' of https://github.com/Azure/azure-cli-extension…
msyyc May 14, 2021
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
6 changes: 3 additions & 3 deletions scripts/ci/avail-ext-doc/list-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ The list of extensions is also available from the CLI. To get it, run [az exten
az extension list-available --output table
```

| Name | Version | Summary | Preview |
|------|---------|---------|---------|{% for extension in extensions %}
| [{{ extension.name }}]({{ extension.project_url }}) | {{ extension.version }} | {{ extension.desc }} | {{ extension.preview }} |{% endfor %}
| Extension | Required Minimum CLI Version | Description | Status | Release Notes |
|----|-----------------|-------------|---------|---------------|{% for extension in extensions %}
|[{{ extension.name }}]({{ extension.project_url }}) | {{ extension.min_cli_core_version }} | {{ extension.desc }} | {{ extension.status }} | [{{extension.version}}]({{extension.history}}) |{% endfor %}
20 changes: 17 additions & 3 deletions scripts/ci/avail-ext-doc/update_extension_list.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
from pkg_resources import parse_version

from jinja2 import Template # pylint: disable=import-error

import requests

SCRIPTS_LOCATION = os.path.abspath(os.path.join('.', 'scripts'))

Expand All @@ -36,12 +36,26 @@ def get_extensions():
for _, exts in index_extensions.items():
# Get latest version
exts = sorted(exts, key=lambda c: parse_version(c['metadata']['version']), reverse=True)

# some extension modules may not include 'HISTORY.rst'
project_url = exts[0]['metadata']['extensions']['python.details']['project_urls']['Home']
history_tmp = project_url + '/HISTORY.rst'
history = project_url if str(requests.get(history_tmp).status_code) == '404' else history_tmp
if exts[0]['metadata'].get('azext.isPreview'):
status = 'Preview'
elif exts[0]['metadata'].get('azext.isExperimental'):
status = 'Experimental'
else:
status = 'GA'

extensions.append({
'name': exts[0]['metadata']['name'],
'desc': exts[0]['metadata']['summary'],
'min_cli_core_version': exts[0]['metadata']['azext.minCliCoreVersion'],
'version': exts[0]['metadata']['version'],
'project_url': exts[0]['metadata']['extensions']['python.details']['project_urls']['Home'],
'preview': 'Yes' if exts[0]['metadata'].get('azext.isPreview') else ''
'project_url': project_url,
'history': history,
'status': status
})
return extensions

Expand Down