Added github action to update feature catalog MD file #1714
Conversation
|
🎊 PR Preview has been successfully built and deployed to https://localstack-docs-preview-pr-1714.surge.sh 🎊 |
k-a-il
changed the title
| - name: Latest run-id from community repository | ||
| run: | | ||
| latest_workflow_id=$(curl -s https://api.github.com/repos/localstack/localstack/actions/workflows \ | ||
| | jq '.workflows[] | select(.name=="Artifact with features files").id') |
There was a problem hiding this comment.
comment: similar to above: https://github.com/localstack/localstack-ext/pull/4302#discussion_r2028188292
| name: Update feature catalog page | ||
| on: | ||
| schedule: | ||
| - cron: 0 10 * * MON |
There was a problem hiding this comment.
comment: this would change as per relevant changes in https://github.com/localstack/localstack-ext/pull/4302#discussion_r2028189748.
| - name: Latest run-id from ext repository | ||
| run: | | ||
| latest_workflow_id=$(curl -s https://api.github.com/repos/localstack/localstack-ext/actions/workflows \ | ||
| | jq '.workflows[] | select(.name=="Artifact with features files").id') |
There was a problem hiding this comment.
comment: similar to above: https://github.com/localstack/localstack-ext/pull/4302#discussion_r2028188292
|
|
||
| import yaml | ||
|
|
||
| DEFAULT_STATUS = 'not supported' |
There was a problem hiding this comment.
comment: We should consider having consistency in the status being displayed, as in features_schema.json.
"enum": ["supported", "unsupported"]
That means using either unsupported or not supported.
| github-token: ${{ secrets.GH_PAT_FEATURE_CATALOG_PAGE_PRO }} # PAT with access to artifacts from GH Actions | ||
| run-id: ${{ env.FEATURES_ARTIFACTS_EXT_RUN_ID }} | ||
|
|
||
| - name: Generate feature catalog page |
There was a problem hiding this comment.
ques: do we have a sample MD file generated from this? If yes, could you please link it in the comments/description of the PR?
| print(f"Error parsing YAML file: {e}") | ||
| sys.exit(1) | ||
| except FileNotFoundError: | ||
| print(f"YAML file not found: {file_path}") |
There was a problem hiding this comment.
suggestion: Consider printing the errors with an annotation.
This PR adds a GitHub Action to generate a feature catalog Markdown file, used here. The file is created based on
features.ymlartifacts downloaded from thelocalstack/localstackandlocalstack/localstack-extrepositories.