Release 2.3.0

.github/workflows/build-schema.yml

@@ -7,6 +7,7 @@ on:
   pull_request:
     branches:
       - main
+      - stable**
   workflow_dispatch:
     inputs:
       ods_branch:
@@ -21,7 +22,7 @@ on:
 
 jobs:
   ods_tools:
-    if: inputs.ods_branch != ''
+    if: ${{ github.event_name != 'workflow_dispatch' }}
     uses: OasisLMF/ODS_Tools/.github/workflows/build.yml@main
     secrets: inherit
     with:
@@ -31,7 +32,9 @@ jobs:
     if: ${{ ! failure() || ! cancelled() }}
     needs: ods_tools
     env:
-      SCHEMA: 'reports/openapi-schema.json'
+      SCHEMA_ALL: 'reports/openapi-schema.json'
+      SCHEMA_V1: 'reports/v1-openapi-schema.json'
+      SCHEMA_V2: 'reports/v2-openapi-schema.json'
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v3
@@ -59,15 +62,45 @@ jobs:
 
     - name: Generate OpenAPI
       run: |
-        test -d $(dirname ${{ env.SCHEMA }}) || mkdir -p $(dirname ${{ env.SCHEMA }})
+        test -d $(dirname ${{ env.SCHEMA_ALL }}) || mkdir -p $(dirname ${{ env.SCHEMA_ALL }})
         python ./manage.py migrate
-        python ./manage.py generate_swagger ${{ env.SCHEMA }}
+        python ./manage.py generate_swagger ${{ env.SCHEMA_ALL }}
+
+    - name: Generate OpenAPI (only v1)
+      run: |
+        test -d $(dirname ${{ env.SCHEMA_V1 }}) || mkdir -p $(dirname ${{ env.SCHEMA_V1 }})
+        python ./manage.py migrate
+        python ./manage.py generate_swagger ${{ env.SCHEMA_V1 }}
+      env:
+        OASIS_GEN_SWAGGER_V1: 1
+
+    - name: Generate OpenAPI (only v2)
+      run: |
+        test -d $(dirname ${{ env.SCHEMA_V2 }}) || mkdir -p $(dirname ${{ env.SCHEMA_V2 }})
+        python ./manage.py migrate
+        python ./manage.py generate_swagger ${{ env.SCHEMA_V2 }}
+      env:
+        OASIS_GEN_SWAGGER_V2: 1
 
     - name: Store OpenAPI schema
       uses: actions/upload-artifact@v3
       with:
         name: openapi-schema
-        path: ${{ env.SCHEMA }}
+        path: ${{ env.SCHEMA_ALL }}
+        retention-days: 3
+
+    - name: Store OpenAPI schema (only v1)
+      uses: actions/upload-artifact@v3
+      with:
+        name: v1-openapi-schema
+        path: ${{ env.SCHEMA_V1 }}
+        retention-days: 3
+
+    - name: Store OpenAPI schema (only v2)
+      uses: actions/upload-artifact@v3
+      with:
+        name: v2-openapi-schema
+        path: ${{ env.SCHEMA_V2 }}
         retention-days: 3
 
     - name: Test Schema

.github/workflows/code-quality.yml

@@ -30,7 +30,7 @@ jobs:
 
       - name: Run (partial) flake8
         if: ${{ ! cancelled() }}
-        run: flake8 --select F401,F522,F524,F541 --show-source src/
+        run: flake8 --select F401,F522,F524,F541 --show-source src/ --config tox.ini
 
       - name: check PEP8 compliance
         if: ${{ ! cancelled() }}

.github/workflows/publish.yml

@@ -96,7 +96,7 @@ jobs:
     env:
       pre_release: ${{ inputs.pre_release == '' && 'false' || inputs.pre_release }}
       push_latest: ${{ inputs.push_latest == '' && 'false' || inputs.push_latest }}
-      latest_tag: '2-latest'
+      latest_tag: 'latest'
 
       release_tag: ${{ inputs.release_tag }}
       prev_release_tag: ${{ inputs.prev_release_tag }}
@@ -367,12 +367,31 @@ jobs:
         name: openapi-schema
         path: ${{ github.workspace }}/
 
+    - name: Download API schema (v1)
+      uses: actions/download-artifact@v3
+      with:
+        name: v1-openapi-schema
+        path: ${{ github.workspace }}/
+
+    - name: Download API schema (v2)
+      uses: actions/download-artifact@v3
+      with:
+        name: v2-openapi-schema
+        path: ${{ github.workspace }}/
+
     - name: Name API schema
       id: api_schema
       run: |
         schema_filename="openapi-schema-${{ env.release_tag }}.json"
+        v1_schema_filename="v1-openapi-schema-${{ env.release_tag }}.json"
+        v2_schema_filename="v2-openapi-schema-${{ env.release_tag }}.json"
+
         mv openapi-schema.json  $schema_filename
-        echo "filename=$schema_filename" >> $GITHUB_OUTPUT
+        mv v1-openapi-schema.json  $v1_schema_filename
+        mv v2-openapi-schema.json  $v2_schema_filename
+        echo "filename_all=$schema_filename" >> $GITHUB_OUTPUT
+        echo "filename_v1=$v1_schema_filename" >> $GITHUB_OUTPUT
+        echo "filename_v2=$v2_schema_filename" >> $GITHUB_OUTPUT
 
     # --- Create Changelog --- #
     - name: Tag Release
@@ -464,17 +483,38 @@ jobs:
         prerelease: ${{ env.pre_release }}
 
     # --- Attach build assest --- #
-    - name: Upload Schema
+    - name: Upload Schema (base)
       id: upload-source-release-asset
       uses: actions/upload-release-asset@v1
       env:
         GITHUB_TOKEN: ${{ secrets.BUILD_GIT_TOKEN }}
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
-        asset_path: ${{ github.workspace }}/${{ steps.api_schema.outputs.filename }}
-        asset_name: ${{ steps.api_schema.outputs.filename }}
+        asset_path: ${{ github.workspace }}/${{ steps.api_schema.outputs.filename_all }}
+        asset_name: ${{ steps.api_schema.outputs.filename_all }}
+        asset_content_type: application/json
+
+    - name: Upload Schema (v1)
+      id: upload-source-release-asset-v1
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.BUILD_GIT_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: ${{ github.workspace }}/${{ steps.api_schema.outputs.filename_v1 }}
+        asset_name: ${{ steps.api_schema.outputs.filename_v1 }}
         asset_content_type: application/json
 
+    - name: Upload Schema (v2)
+      id: upload-source-release-asset-v2
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.BUILD_GIT_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: ${{ github.workspace }}/${{ steps.api_schema.outputs.filename_v2 }}
+        asset_name: ${{ steps.api_schema.outputs.filename_v2 }}
+        asset_content_type: application/json
     # --- Slack notify --- #
     - name: slack message vars
       id: slack_vars

.github/workflows/scan-external.yml

@@ -6,7 +6,7 @@ on:
       - main
   pull_request:
     branches:
-      - main
+      - stable**
 
   workflow_dispatch:
     inputs:

.github/workflows/scan.yml

@@ -7,6 +7,7 @@ on:
   pull_request:
     branches:
       - main
+      - stable**  
   schedule:
     - cron:  '0 */6 * * *' # Run scan every 6 hours