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

docs(v2): deployment, add required Github token scope infos #3565

Merged
merged 1 commit into from
Oct 12, 2020

Conversation

russtaylor
Copy link
Contributor

Fixes #3189

Motivation

Fix #3189 - clarify the necessary 'scope' required on the personal access token for deploying to GitHub pages through both Travis CI and Azure Pipelines

Have you read the Contributing Guidelines on pull requests?

Yes!

Test Plan

Because this is a documentation-only change, I haven't done any testing on the software itself. However, I performed manual testing to ensure the documentation change listed here is correct. The testing included:

  • Creating a test Docusaurus repository
  • Creating a personal access token
    • Testing using different 'scopes' on the personal access token
    • Noted the minimum 'scope' required to successfully deploy
  • Deploying successfully to GitHub pages

Related PRs

N/A

I did a fair amount of testing to ensure that this was the correct scope required. Unfortunately, I couldn't find a smaller subset of scopes that would give sufficient permission to deploy to GitHub Pages.
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Oct 9, 2020
@docusaurus-bot
Copy link
Contributor

Deploy preview for docusaurus-2 ready!

Built without sensitive environment variables with commit ca84f09

https://deploy-preview-3565--docusaurus-2.netlify.app

@slorber
Copy link
Collaborator

slorber commented Oct 12, 2020

thanks, LGTM

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Oct 12, 2020
@slorber slorber changed the title Deployment Docs: Specify the repo scope for PAT. docs(v2): deployment, add required Github token scope infos Oct 12, 2020
@slorber slorber merged commit 2e51034 into facebook:master Oct 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve details about Travis CI deployment in docs
4 participants