-
Notifications
You must be signed in to change notification settings - Fork 582
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Upstream changes for v0.5.0 release (#71)
- Loading branch information
1 parent
478cf96
commit 6de0008
Showing
299 changed files
with
36,776 additions
and
2,402 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| notebooks/dataset.zip filter=lfs diff=lfs merge=lfs -text |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| name: docs-build | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: [ main, release-* ] | ||
| types: [ opened, synchronize ] | ||
|
|
||
| push: | ||
| branches: [ main ] | ||
| tags: | ||
| - v* | ||
| workflow_dispatch: | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| defaults: | ||
| run: | ||
| shell: bash | ||
|
|
||
| jobs: | ||
| build-docs: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| - name: Build image | ||
| run: | | ||
| docker build --pull --tag docs-builder:latest --file docs/Dockerfile . | ||
| - name: Build docs | ||
| run: | | ||
| docker run -v $(pwd):/work -w /work docs-builder:latest sphinx-build -b html -d /tmp docs docs/_build/output | ||
| - name: Delete unnecessary files | ||
| run: | | ||
| sudo rm -rf docs/_build/jupyter_execute | ||
| sudo rm -rf docs/_build/.buildinfo | ||
| - name: Upload HTML | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: html-build-artifact | ||
| path: docs/_build/ | ||
| if-no-files-found: error | ||
| retention-days: 1 | ||
| - name: Store PR information | ||
| if: ${{ github.event_name == 'pull_request' }} | ||
| run: | | ||
| mkdir ./pr | ||
| echo ${{ github.event.number }} > ./pr/pr.txt | ||
| echo ${{ github.event.pull_request.merged }} > ./pr/merged.txt | ||
| echo ${{ github.event.action }} > ./pr/action.txt | ||
| - name: Upload PR information | ||
| if: ${{ github.event_name == 'pull_request' }} | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: pr | ||
| path: pr/ | ||
|
|
||
| store-html: | ||
| needs: [ build-docs ] | ||
| if: ${{ github.event_name == 'push' }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: "gh-pages" | ||
| - name: Initialize Git configuration | ||
| run: | | ||
| git config user.name docs-build | ||
| git config user.email [email protected] | ||
| - name: Download artifacts | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: html-build-artifact | ||
| - name: Copy HTML directories | ||
| run: | | ||
| ls -asl | ||
| - name: Store bleeding edge docs from main | ||
| if: ${{ github.ref == 'refs/heads/main' }} | ||
| run: | | ||
| mkdir main || true | ||
| rsync -av --progress --delete output/ main/ | ||
| git add main | ||
| - name: Store docs for a release tag | ||
| if: ${{ startsWith(github.ref, 'refs/tags/v') }} | ||
| env: | ||
| LATEST: ${{ contains(github.event.head_commit.message, '/not-latest') && 'not-true' || 'true' }} | ||
| run: | | ||
| printenv LATEST | ||
| if [[ "${GITHUB_REF}" =~ "-rc" ]]; then | ||
| echo "Not saving documents for release candidates." | ||
| exit 0 | ||
| fi | ||
| if [[ "${GITHUB_REF}" =~ v([0-9]+\.[0-9]+\.[0-9]+) ]]; then | ||
| TAG="${BASH_REMATCH[1]}" | ||
| mkdir "${TAG}" || true | ||
| rsync -av --progress --delete output/ "${TAG}/" | ||
| git add "${TAG}/" | ||
| if [[ "${LATEST}" == 'true' ]]; then | ||
| mkdir latest || true | ||
| rsync -av --progress --delete output/ latest/ | ||
| cp output/versions.json . | ||
| git add latest | ||
| git add versions.json | ||
| fi | ||
| fi | ||
| - name: Check or create dot-no-jekyll file | ||
| run: | | ||
| if [ -f ".nojekyll" ]; then | ||
| echo "The dot-no-jekyll file already exists." | ||
| exit 0 | ||
| fi | ||
| touch .nojekyll | ||
| git add .nojekyll | ||
| - name: Check or create redirect page | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| run: | | ||
| resp=$(grep 'http-equiv="refresh"' index.html 2>/dev/null) || true | ||
| if [ -n "${resp}" ]; then | ||
| echo "The redirect file already exists." | ||
| exit 0 | ||
| fi | ||
| # If any of these commands fail, fail the build. | ||
| html_url=$(gh api "repos/${GITHUB_REPOSITORY}/pages" --jq ".html_url") | ||
| # Beware ugly quotation mark avoidance in the foll lines. | ||
| echo '<!DOCTYPE html>' > index.html | ||
| echo '<html>' >> index.html | ||
| echo ' <head>' >> index.html | ||
| echo ' <title>Redirect to documentation</title>' >> index.html | ||
| echo ' <meta charset="utf-8">' >> index.html | ||
| echo ' <meta http=equiv="refresh" content="3; URL='${html_url}'/latest/index.html">' >> index.html | ||
| echo ' <link rel="canonical" href="'${html_url}'/latest/index.html">' >> index.html | ||
| echo ' <script language="javascript">' >> index.html | ||
| echo ' function redirect() {' >> index.html | ||
| echo ' window.location.assign("'${html_url}'/latest/index.html")' >> index.html | ||
| echo ' }' >> index.html | ||
| echo ' </script>' >> index.html | ||
| echo ' </head>' >> index.html | ||
| echo ' <body onload="redirect()">' >> index.html | ||
| echo ' <p>Please follow the link to the <a href="'${html_url}'/latest/index.html">' >> index.html | ||
| echo 'latest</a> documentation.</p>' >> index.html | ||
| echo ' </body>' >> index.html | ||
| echo '</html>' >> index.html | ||
| git add index.html | ||
| - name: Commit changes to the GitHub Pages branch | ||
| run: | | ||
| git status | ||
| if git commit -m 'Pushing changes to GitHub Pages.'; then | ||
| git push -f | ||
| else | ||
| echo "Nothing changed." | ||
| fi |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| name: docs-preview-pr | ||
|
|
||
| on: | ||
| workflow_run: | ||
| workflows: [docs-build] | ||
| types: [completed] | ||
|
|
||
| env: | ||
| WF_ID: ${{ github.event.workflow_run.id }} | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| jobs: | ||
| # Always determine if GitHub Pages are configured for this repo. | ||
| get-gh-pages-url: | ||
| if: | ||
| github.event.workflow_run.event == 'pull_request' && | ||
| github.event.workflow_run.conclusion == 'success' | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| url: ${{ steps.api-resp.outputs.html_url || '' }} | ||
| branch: ${{ steps.api-resp.outputs.branch || '' }} | ||
| steps: | ||
| - name: Check for GitHub Pages | ||
| id: api-resp | ||
| run: | | ||
| has_pages=$(gh api "repos/${GITHUB_REPOSITORY}" -q '.has_pages') | ||
| if [ "true" != "${has_pages}" ]; then | ||
| echo "GitHub pages is not active for the repository. Quitting." | ||
| return | ||
| fi | ||
| url=$(gh api "repos/${GITHUB_REPOSITORY}/pages" -q '.html_url') | ||
| branch=$(gh api "repos/${GITHUB_REPOSITORY}/pages" -q '.source.branch') | ||
| echo "html_url=${url}" >> $GITHUB_OUTPUT | ||
| echo "branch=${branch}" >> $GITHUB_OUTPUT | ||
| # Identify the dir for the HTML. | ||
| store-html: | ||
| runs-on: ubuntu-latest | ||
| needs: [get-gh-pages-url] | ||
| if: needs.get-gh-pages-url.outputs.url != '' | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{ needs.get-gh-pages-url.outputs.branch }} | ||
| - name: Initialize Git configuration | ||
| run: | | ||
| git config user.name docs-preview | ||
| git config user.email [email protected] | ||
| - name: Download artifacts | ||
| run: | | ||
| gh run view "${WF_ID}" | ||
| gh run download "${WF_ID}" | ||
| PR=$(cat ./pr/pr.txt) | ||
| MERGED=$(cat ./pr/merged.txt) | ||
| ACTION=$(cat ./pr/action.txt) | ||
| echo "PR_NO=${PR}" >> $GITHUB_ENV | ||
| echo "MERGE_STATUS=${MERGED}" >> $GITHUB_ENV | ||
| echo "PR_ACTION=${ACTION}" >> $GITHUB_ENV | ||
| echo "REVIEW_DIR=review/" >> $GITHUB_ENV | ||
| echo "PR_REVIEW_DIR=review/pr-${PR}" >> $GITHUB_ENV | ||
| # Remove the pr artifact directory so that it does not | ||
| # appear in listings or confuse git with untracked files. | ||
| rm -rf ./pr | ||
| # Permutations: | ||
| # - PR was updated, PR_ACTION is !closed, need to delete review directory and update it. | ||
| # - PR was closed (regardless of merge), PR_ACTION is closed, need to delete review directory. | ||
|
|
||
| # If this PR is still open, store HTML in a review directory. | ||
| - name: Handle HTML review directory for open PRs and updates to PRs | ||
| if: env.MERGE_STATUS == 'false' && env.PR_ACTION != 'closed' | ||
| run: | | ||
| rm -rf "${{ env.PR_REVIEW_DIR }}" 2>/dev/null || true | ||
| if [ ! -d "${{ env.REVIEW_DIR }}" ]; then | ||
| mkdir "${{ env.REVIEW_DIR }}" | ||
| fi | ||
| mv ./html-build-artifact/latest/ "${{ env.PR_REVIEW_DIR }}" | ||
| git add "${{ env.PR_REVIEW_DIR }}" | ||
| # If the PR was closed, merged or not, delete review directory. | ||
| - name: Delete HTML review directory for closed PRs | ||
| if: env.PR_ACTION == 'closed' | ||
| run: | | ||
| if [ -d ./html-build-artifact/ ]; then | ||
| rm -rf ./html-build-artifact/ 2>/dev/null | ||
| fi | ||
| if [ -d "${{ env.PR_REVIEW_DIR }}" ]; then | ||
| git rm -rf "${{ env.PR_REVIEW_DIR }}" | ||
| fi | ||
| - name: Commit changes to the GitHub Pages branch | ||
| run: | | ||
| git status | ||
| if git commit -m 'Pushing changes to GitHub Pages.'; then | ||
| git push -f | ||
| else | ||
| echo "Nothing changed." | ||
| fi | ||
| - name: Check for existing documentation review comment | ||
| run: | | ||
| result=$(gh pr view ${{ env.PR_NO }} --json comments -q 'any(.comments[].body; contains("Documentation preview"))') | ||
| echo "COMMENT_EXISTS=${result}" >> $GITHUB_ENV | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| - name: Add HTML review URL comment to a newly opened PR | ||
| if: env.MERGE_STATUS == 'false' && env.COMMENT_EXISTS == 'false' | ||
| env: | ||
| URL: ${{ needs.get-gh-pages-url.outputs.url }} | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| shell: bash | ||
| run: | | ||
| echo -e "## Documentation preview" > body | ||
| echo -e "" >> body | ||
| echo -e "<${{ env.URL }}${{ env.PR_REVIEW_DIR }}>" >> body | ||
| cat body | ||
| gh pr comment ${{ env.PR_NO }} --body-file body |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| name: docs-remove-stale-reviews | ||
|
|
||
| on: | ||
| schedule: | ||
| # 42 minutes after 0:00 UTC on Sundays | ||
| - cron: "42 0 * * 0" | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| remove: | ||
| uses: nvidia-merlin/.github/.github/workflows/docs-remove-stale-reviews-common.yaml@main |
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
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
Oops, something went wrong.