Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: Add automatic uploading for docs previews #4013

Merged
merged 2 commits into from
Apr 11, 2023

Conversation

seemethere
Copy link
Member

@seemethere seemethere commented Apr 11, 2023

Adds automatic uploading for docs previews by specifying a special directory for users to put there documentation in (RUNNER_DOCS_DIR) and then having the default linux job take those and upload them to S3.

Also adds a test to verify that we are doing the upload correctly.

Example:

  upload-docs:
    uses: pytorch/test-infra/.github/workflows/linux_job.yml@main
    with:
      runner: linux.2xlarge
      script: |
        echo "hello" > "${RUNNER_DOCS_DIR}/index.html"

@seemethere seemethere requested a review from pmeier April 11, 2023 19:45
@vercel
Copy link

vercel bot commented Apr 11, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
torchci ⬜️ Ignored (Inspect) Apr 11, 2023 8:17pm

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Apr 11, 2023
@seemethere seemethere requested a review from DanilBaibak April 11, 2023 19:45
@seemethere seemethere force-pushed the seemethere/add_automatic_docs_uploading branch 8 times, most recently from 7542607 to c70969c Compare April 11, 2023 20:06
Adds automatic uploading for docs previews by specifying a special
directory for users to put there documentation in (RUNNER_DOCS_DIR) and
then having the default linux job take those and upload them to S3.

Also adds a test to verify that we are doing the upload correctly.

Signed-off-by: Eli Uriegas <eliuriegas@meta.com>
@seemethere seemethere force-pushed the seemethere/add_automatic_docs_uploading branch from c70969c to 6e67f82 Compare April 11, 2023 20:13
Signed-off-by: Eli Uriegas <eliuriegas@meta.com>
@seemethere seemethere merged commit 9ea89ee into main Apr 11, 2023
@seemethere seemethere deleted the seemethere/add_automatic_docs_uploading branch April 11, 2023 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants