From 931d6baca2063945a38e207633a8862b276c8d3b Mon Sep 17 00:00:00 2001 From: "Nat Kershaw (MSFT)" Date: Thu, 30 Mar 2023 14:37:56 -0700 Subject: [PATCH] Fix website publish trigger (#15285) --- .github/workflows/publish-gh-pages.yml | 101 +++++++++++++++++++++++++ docs/build/index.md | 2 + 2 files changed, 103 insertions(+) create mode 100644 .github/workflows/publish-gh-pages.yml diff --git a/.github/workflows/publish-gh-pages.yml b/.github/workflows/publish-gh-pages.yml new file mode 100644 index 0000000000..5ddb1e3bb0 --- /dev/null +++ b/.github/workflows/publish-gh-pages.yml @@ -0,0 +1,101 @@ +# Sample workflow for building and deploying a Jekyll site to GitHub Pages +name: Publish site + +on: + # Runs on pushes targeting the branch where the website sources live + push: + branches: ["gh-pages"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + ref: gh-pages + + - name: Setup Pages + uses: actions/configure-pages@v3 + + - name: Build with Jekyll + uses: actions/jekyll-build-pages@v1 + with: + source: ./ + destination: ./_site + + - name: Download C apidocs artifact + uses: dawidd6/action-download-artifact@v2 + with: + name: onnxruntime-c-apidocs + workflow: publish-c-apidocs.yml + branch: main + path: apidocs + + - name: Download C# apidocs artifact + uses: dawidd6/action-download-artifact@v2 + with: + name: onnxruntime-csharp-apidocs + workflow: publish-csharp-apidocs.yml + branch: main + path: apidocs + + - name: Download Java apidocs artifact + uses: dawidd6/action-download-artifact@v2 + with: + name: onnxruntime-java-apidocs + workflow: publish-java-apidocs.yml + branch: main + path: apidocs + + - name: Download Python apidocs artifact + uses: dawidd6/action-download-artifact@v2 + with: + name: onnxruntime-python-apidocs + workflow: publish-python-apidocs.yml + branch: main + path: apidocs + + - name: Move apidocs folder into place + run: | + sudo rm -rf _site/docs/api/c + sudo mv apidocs/docs/api/c _site/docs/api + sudo rm -rf _site/docs/api/csharp + sudo mv apidocs/docs/api/csharp _site/docs/api + sudo rm -rf _site/docs/api/java + sudo mv apidocs/docs/api/java _site/docs/api + sudo rm -rf _site/docs/api/python + sudo mv apidocs/docs/api/python _site/docs/api + + - name: Upload site + uses: actions/upload-pages-artifact@v1 + with: + retention-days: 21 + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 diff --git a/docs/build/index.md b/docs/build/index.md index 2f2d358712..be906d8b9c 100644 --- a/docs/build/index.md +++ b/docs/build/index.md @@ -8,4 +8,6 @@ redirect_from: /docs/how-to/build # Build ONNX Runtime from source {: .no_toc } +Build ONNX Runtime from source if you need to access a feature that is not already in a released package. + For production deployments, it's strongly recommended to build only from an [official release branch](https://github.com/microsoft/onnxruntime/releases).