ari-stubs: Fix more local anchor references

Also allow CreateDocs job to be run manually with default branches.
This commit is contained in:
George Joseph 2023-09-05 13:02:19 -06:00
parent 8ce313c5b3
commit 1862a36c3b
3 changed files with 21 additions and 5 deletions

View File

@ -4,7 +4,7 @@ on:
inputs: inputs:
branches: branches:
description: "JSON array of branches: ['18','20'] (no spaces)" description: "JSON array of branches: ['18','20'] (no spaces)"
required: true required: false
type: string type: string
schedule: schedule:
# Times are UTC # Times are UTC
@ -14,15 +14,29 @@ env:
ASTERISK_REPO: ${{ github.repository }} ASTERISK_REPO: ${{ github.repository }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DEFAULT_BRANCHES: ${{ vars.WIKIDOC_BRANCHES }}
INPUT_BRANCHES: ${{ inputs.branches }}
jobs: jobs:
CreateDocsDebug: CreateDocsDebug:
runs-on: ubuntu-latest runs-on: ubuntu-latest
outputs:
manual_branches: ${{ steps.setup.outputs.manual_branches }}
steps: steps:
- name: setup
run: |
MANUAL_BRANCHES="$INPUT_BRANCHES"
[ -z "$MANUAL_BRANCHES" ] && MANUAL_BRANCHES="$DEFAULT_BRANCHES" || :
echo "manual_branches=${MANUAL_BRANCHES}"
echo "manual_branches=${MANUAL_BRANCHES}" >>${GITHUB_OUTPUT}
exit 0
- name: DumpEnvironment - name: DumpEnvironment
uses: asterisk/asterisk-ci-actions/DumpEnvironmentAction@main uses: asterisk/asterisk-ci-actions/DumpEnvironmentAction@main
with: with:
action-vars: ${{toJSON(inputs)}} action-inputs: ${{toJSON(inputs)}}
action-vars: ${{ toJSON(steps.setup.outputs) }}
CreateDocsScheduledMatrix: CreateDocsScheduledMatrix:
needs: [ CreateDocsDebug ] needs: [ CreateDocsDebug ]
@ -73,7 +87,7 @@ jobs:
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
branch: ${{ fromJSON(inputs.branches) }} branch: ${{ fromJSON(vars.WIKIDOC_MANUAL_BRANCHES) }}
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: CreateDocs for ${{matrix.branch}} - name: CreateDocs for ${{matrix.branch}}

View File

@ -5,14 +5,14 @@
|:------ |:------------------------------------ |:------------ |:------- | |:------ |:------------------------------------ |:------------ |:------- |
{{#apis}} {{#apis}}
{{#operations}} {{#operations}}
| {{http_method}} | [{{wiki_path}}](#{{nickname}}) | {{#response_class}}{{#is_primitive}}{{name}}{{/is_primitive}}{{^is_primitive}}[{{wiki_name}}]({{wiki_prefix}}Asterisk_REST_Data_Models#{{lc_singular_name}}){{/is_primitive}}{{/response_class}} | {{{summary}}} | | {{http_method}} | [{{wiki_path}}](#{{nickname_lc}}) | {{#response_class}}{{#is_primitive}}{{name}}{{/is_primitive}}{{^is_primitive}}[{{wiki_name}}]({{wiki_prefix}}Asterisk_REST_Data_Models#{{lc_singular_name}}){{/is_primitive}}{{/response_class}} | {{{summary}}} |
{{/operations}} {{/operations}}
{{/apis}} {{/apis}}
{{#apis}} {{#apis}}
{{#operations}} {{#operations}}
--- ---
[//]: # (anchor:{{nickname}}) [//]: # (anchor:{{nickname_lc}})
## {{nickname}} ## {{nickname}}
### {{http_method}} {{wiki_path}} ### {{http_method}} {{wiki_path}}
{{{wiki_summary}}}{{#wiki_notes}} {{{wiki_notes}}}{{/wiki_notes}} {{{wiki_summary}}}{{#wiki_notes}} {{{wiki_notes}}}{{/wiki_notes}}

View File

@ -367,6 +367,7 @@ class Operation(Stringify):
def __init__(self): def __init__(self):
self.http_method = None self.http_method = None
self.nickname = None self.nickname = None
self.nickname_lc = None
self.response_class = None self.response_class = None
self.parameters = [] self.parameters = []
self.summary = None self.summary = None
@ -378,6 +379,7 @@ class Operation(Stringify):
validate_required_fields(op_json, self.required_fields, context) validate_required_fields(op_json, self.required_fields, context)
self.http_method = op_json.get('httpMethod') self.http_method = op_json.get('httpMethod')
self.nickname = op_json.get('nickname') self.nickname = op_json.get('nickname')
self.nickname_lc = self.nickname.lower()
response_class = op_json.get('responseClass') response_class = op_json.get('responseClass')
self.response_class = response_class and SwaggerType().load( self.response_class = response_class and SwaggerType().load(
response_class, processor, context) response_class, processor, context)