DIG-1355: Sonchau/UUID with fk #40
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Docs | |
on: | |
pull_request: | |
types: [review_requested, ready_for_review] | |
jobs: | |
first_job: | |
name: Update MoH schema | |
runs-on: ubuntu-latest | |
steps: | |
- name: Check out repo | |
uses: actions/checkout@v4 | |
with: | |
submodules: true | |
- name: Install Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "3.12" | |
- name: Install dependencies | |
run: python -m pip install -r requirements/base.txt | |
# - name: Set up Node.js | |
# uses: actions/setup-node@v4 | |
# with: | |
# node-version: 18 | |
# - name: Create package.json file | |
# run: | | |
# echo '{"name": "my-project", "version": "1.0.0"}' > package.json | |
# - name: Install npm | |
# run: npm install | |
- name: Install octokit/rest | |
run: npm install @octokit/rest | |
- name: Generate new schema.json | |
run: | | |
export DJANGO_SETTINGS_MODULE=config.settings.base | |
python manage.py export_openapi_schema --api chord_metadata_service.mohpackets.apis.core.api | python -m json.tool > chord_metadata_service/mohpackets/docs/schema.json | |
- name: Commit and push changes to schema.json | |
uses: actions/github-script@v6 | |
with: | |
script: | | |
const fs = require('fs'); | |
const { Octokit } = require('@octokit/rest'); | |
const octokit = new Octokit({ request: { fetch: fetch, }, auth: "${{ secrets.GITHUB_TOKEN }}" }); | |
const { commitAndPushChanges } = require("./.github/commitFile.js"); | |
await commitAndPushChanges('schema.json', `${{ github.head_ref }}`, fs, octokit, context); | |
- name: Install widdershins | |
run: npm install -g widdershins | |
- name: Install PyYAML | |
run: pip install PyYAML | |
- name: Convert schema to OpenAPI documentation | |
run: | | |
npx widdershins ./chord_metadata_service/mohpackets/docs/schema.json -o ./chord_metadata_service/mohpackets/docs/schema.md -u ./chord_metadata_service/mohpackets/docs/widdershins/templates/openapi3 -c true --omitHeader true | |
- name: Convert schema.json to schema.yml | |
run: python -c 'import json, yaml; json.load(open("chord_metadata_service/mohpackets/docs/schema.json")); print(yaml.dump(json.load(open("chord_metadata_service/mohpackets/docs/schema.json"))))' > chord_metadata_service/mohpackets/docs/schema.yml | |
- name: Update schema with last SHA | |
run: | | |
REPO_NAME=${{ github.repository }} | |
SHA=${{ github.sha }} | |
DOCS_PATH="chord_metadata_service/mohpackets/docs/" | |
SCHEMA_PATHS=( | |
"${DOCS_PATH}schema.json" | |
"${DOCS_PATH}schema.yml" | |
"${DOCS_PATH}schema.md" | |
) | |
for path in "${SCHEMA_PATHS[@]}"; do | |
sed -i "s|This is the RESTful API for the MoH Service.|This is the RESTful API for the MoH Service. Based on https://raw.githubusercontent.com/$REPO_NAME/$SHA/$path|" "$path" | |
done | |
- name: Commit and push changes | |
uses: actions/github-script@v6 | |
with: | |
script: | | |
const fs = require('fs'); | |
const { Octokit } = require('@octokit/rest'); | |
const octokit = new Octokit({ request: { fetch: fetch, }, auth: "${{ secrets.GITHUB_TOKEN }}" }); | |
const { commitAndPushChanges } = require("./.github/commitFile.js"); | |
await commitAndPushChanges('schema.json', `${{ github.head_ref }}`, fs, octokit, context); | |
await commitAndPushChanges('schema.yml', `${{ github.head_ref }}`, fs, octokit, context); | |
await commitAndPushChanges('schema.md', `${{ github.head_ref }}`, fs, octokit, context); |