diff --git a/.github/workflows/publish-docusaurus.yaml b/.github/workflows/publish-docusaurus.yaml index 4eb2423c0..20ce0b41b 100644 --- a/.github/workflows/publish-docusaurus.yaml +++ b/.github/workflows/publish-docusaurus.yaml @@ -32,6 +32,9 @@ on: downstream-version: required: false type: string + push: + branches: + - docs/docusaurus-publishing jobs: publish-docusaurus: @@ -57,52 +60,12 @@ jobs: - name: "Gather documentation files" run: | - mkdir -p ${{ runner.temp }}/tractusx-edc/Connector\ Kit - rsync -a --prune-empty-dirs --exclude 'build' --include '*' ./docs/kit/* ${{ runner.temp }}/tractusx-edc/Connector\ Kit/ - - mkdir -p ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Operation\ View/03_deployment_via_helm - cp ./docs/samples/example-dataspace/README.md ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Operation\ View/03_deployment_via_helm/00_example_dataspace.md - cp ./docs/samples/edr-api-overview/edr-api-overview.md ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Operation\ View/03_deployment_via_helm/01_edr_api_overview.md - - mkdir -p ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Operation\ View/04_Test\ Your\ Setup - cp ./docs/development/postman/README.md ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Operation\ View/04_Test\ Your\ Setup/00_postman.md - cp ./docs/samples/Transfer\ Data.md ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Operation\ View/04_Test\ Your\ Setup/02_transfer_data.md - cp -r ./docs/samples/diagrams ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Operation\ View/04_Test\ Your\ Setup/ - - mkdir -p ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Operation\ View/05_Migration - cp ./docs/migration/* ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Operation\ View/05_Migration/ - - mkdir -p ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Development\ View - cp ./docs/README.md ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Development\ View/00_tractusx_edc.md - cp ./core/edr-core/README.md ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Development\ View/06_edr_core.md - cp ./docs/development/Release.md ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Development\ View/07_release.md - - mkdir -p ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Development\ View/03_EDC\ Controlplane - rsync -a --prune-empty-dirs --include '*/' --exclude 'build' --include '*.md' --include '*.png' --include '*.puml' --exclude '*' ./edc-controlplane/* ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Development\ View/03_EDC\ Controlplane - - mkdir -p ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Development\ View/04_EDC\ Dataplane - rsync -a --prune-empty-dirs --include '*/' --exclude 'build' --include '*.md' --include '*.png' --include '*.puml' --exclude '*' ./edc-dataplane/* ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Development\ View/04_EDC\ Dataplane - - mkdir -p ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Development\ View/05_EDC\ Extensions - rsync -a --prune-empty-dirs --include '*/' --exclude 'build' --include '*.md' --include '*.png' --include '*.puml' --exclude '*' ./edc-extensions/* ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Development\ View/05_EDC\ Extensions - - mkdir -p ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Documentation - cp ./docs/development/coding-principles.md ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Documentation/02_coding_principles.md - cp ./pr_etiquette.md ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Documentation/03_pr_etiquette.md - cp ./styleguide.md ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Documentation/04_styleguide.md - mkdir -p ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Documentation/resources - cp ./resources/tx-checkstyle-config.xml ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Documentation/resources - cp ./SECURITY.md ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Documentation/05_security.md - mkdir -p ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Documentation/resources - cp ./resources/save_actions_scr.png ${{ runner.temp }}/tractusx-edc/Connector\ Kit/Documentation/resources/ - - curl https://api.swaggerhub.com/apis/tractusx-edc/${{ env.DOWNSTREAM_VERSION }}/swagger.yaml > ${{ runner.temp }}/tractusx-edc/tractusx-edc-${{ env.DOWNSTREAM_VERSION }}.yaml - - zip -r ${{ runner.temp }}/tractusx-edc-docusaurus.zip ${{ runner.temp }}/tractusx-edc + chmod +x ./resources/create_kit_documentation.sh + ./resources/create_kit_documentation.sh ${{ runner.temp }} $(pwd) ${{ env.DOWNSTREAM_VERSION }} - name: Publish zip to GitHub Release uses: svenstaro/upload-release-action@v2 with: - repo_token: "${{ secrets.GITHUB_TOKEN }}" - file: "${{ runner.temp }}/tractusx-edc-docusaurus.zip" - tag: "${{ steps.extract_version.outputs.DOWNSTREAM_VERSION }}" + repo_token: ${{ secrets.GITHUB_TOKEN }} + file: ${{ runner.temp }}/tractusx-edc-docusaurus-${{ env.DOWNSTREAM_VERSION }}.zip + tag: ${{ steps.extract_version.outputs.DOWNSTREAM_VERSION }} diff --git a/resources/create_kit_documentation.sh b/resources/create_kit_documentation.sh new file mode 100644 index 000000000..ae14787f6 --- /dev/null +++ b/resources/create_kit_documentation.sh @@ -0,0 +1,50 @@ +#!/bin/bash + +output_dir=$1 +repo_root=$2 +release_version=$3 + +cd ${repo_root} + +mkdir -p ${output_dir}/tractusx-edc/Connector\ Kit/ +rsync -a --prune-empty-dirs --exclude 'build' --include '*' ./docs/kit/* ${output_dir}/tractusx-edc/Connector\ Kit/ + +mkdir -p ${output_dir}/tractusx-edc/Connector\ Kit/Operation\ View/03_deployment_via_helm +cp ./docs/samples/example-dataspace/README.md ${output_dir}/tractusx-edc/Connector\ Kit/Operation\ View/03_deployment_via_helm/00_example_dataspace.md +cp ./docs/samples/edr-api-overview/edr-api-overview.md ${output_dir}/tractusx-edc/Connector\ Kit/Operation\ View/03_deployment_via_helm/01_edr_api_overview.md + +mkdir -p ${output_dir}/tractusx-edc/Connector\ Kit/Operation\ View/04_Test\ Your\ Setup +cp ./docs/development/postman/README.md ${output_dir}/tractusx-edc/Connector\ Kit/Operation\ View/04_Test\ Your\ Setup/00_postman.md +cp ./docs/samples/Transfer\ Data.md ${output_dir}/tractusx-edc/Connector\ Kit/Operation\ View/04_Test\ Your\ Setup/02_transfer_data.md +cp -r ./docs/samples/diagrams ${output_dir}/tractusx-edc/Connector\ Kit/Operation\ View/04_Test\ Your\ Setup/ + +mkdir -p ${output_dir}/tractusx-edc/Connector\ Kit/Operation\ View/05_Migration +cp ./docs/migration/* ${output_dir}/tractusx-edc/Connector\ Kit/Operation\ View/05_Migration/ + +mkdir -p ${output_dir}/tractusx-edc/Connector\ Kit/Development\ View +cp ./docs/README.md ${output_dir}/tractusx-edc/Connector\ Kit/Development\ View/00_tractusx_edc.md +cp ./core/edr-core/README.md ${output_dir}/tractusx-edc/Connector\ Kit/Development\ View/06_edr_core.md +cp ./docs/development/Release.md ${output_dir}/tractusx-edc/Connector\ Kit/Development\ View/07_release.md + +mkdir -p ${output_dir}/tractusx-edc/Connector\ Kit/Development\ View/03_EDC\ Controlplane +rsync -a --prune-empty-dirs --include '*/' --exclude 'build' --include '*.md' --include '*.png' --include '*.puml' --exclude '*' ./edc-controlplane/* ${output_dir}/tractusx-edc/Connector\ Kit/Development\ View/03_EDC\ Controlplane + +mkdir -p ${output_dir}/tractusx-edc/Connector\ Kit/Development\ View/04_EDC\ Dataplane +rsync -a --prune-empty-dirs --include '*/' --exclude 'build' --include '*.md' --include '*.png' --include '*.puml' --exclude '*' ./edc-dataplane/* ${output_dir}/tractusx-edc/Connector\ Kit/Development\ View/04_EDC\ Dataplane + +mkdir -p ${output_dir}/tractusx-edc/Connector\ Kit/Development\ View/05_EDC\ Extensions +rsync -a --prune-empty-dirs --include '*/' --exclude 'build' --include '*.md' --include '*.png' --include '*.puml' --exclude '*' ./edc-extensions/* ${output_dir}/tractusx-edc/Connector\ Kit/Development\ View/05_EDC\ Extensions + +mkdir -p ${output_dir}/tractusx-edc/Connector\ Kit/Documentation +cp ./docs/development/coding-principles.md ${output_dir}/tractusx-edc/Connector\ Kit/Documentation/02_coding_principles.md +cp ./pr_etiquette.md ${output_dir}/tractusx-edc/Connector\ Kit/Documentation/03_pr_etiquette.md +cp ./styleguide.md ${output_dir}/tractusx-edc/Connector\ Kit/Documentation/04_styleguide.md +mkdir -p ${output_dir}/tractusx-edc/Connector\ Kit/Documentation/resources +cp ./resources/tx-checkstyle-config.xml ${output_dir}/tractusx-edc/Connector\ Kit/Documentation/resources +cp ./SECURITY.md ${output_dir}/tractusx-edc/Connector\ Kit/Documentation/05_security.md +mkdir -p ${output_dir}/tractusx-edc/Connector\ Kit/Documentation/resources +cp ./resources/save_actions_scr.png ${output_dir}/tractusx-edc/Connector\ Kit/Documentation/resources/ + +curl https://api.swaggerhub.com/apis/tractusx-edc/${release_version}/swagger.yaml > ${output_dir}/tractusx-edc/tractusx-edc-${release_version}.yaml + +zip -r ${output_dir}/tractusx-edc-docusaurus-${release_version}.zip ${output_dir}/tractusx-edc \ No newline at end of file