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(deployment): add permissions config to github action file in v2.4.3 #9377

Conversation

chillinPanda
Copy link
Contributor

@chillinPanda chillinPanda commented Oct 6, 2023

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

this is already documented in the latest version by commit 35183d7

See also #8877

This is also working for v2.4.3 and needed for using GitHub Pages and Actions with the default setting for the action's automatic GITHUB_TOKEN

Since v2.4.3 is the current version, which is shown by default, doc readers should also see the permission config, so they don't run into permission issues.

Test Plan

no code change, only mdx

Test links

Scroll down to Triggering deployment with GitHub Actions

  • Tab Same -> Expander GitHub action files -> Code box .github/workflows/deploy.yml
  • Tab Remote -> Expander GitHub action files -> Code box .github/workflows/deploy.yml

Deploy preview: https://deploy-preview-9377--docusaurus-2.netlify.app/docs/deployment#triggering-deployment-with-github-actions

Related issues/PRs

…4.3...

this is already documented in the latest version by commit 35183d7

See also facebook#8877

This is also working for v2.4.3 and needed for using GitHub Pages and Actions with the default setting for the action's automatic GITHUB_TOKEN
@netlify
Copy link

netlify bot commented Oct 6, 2023

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 78675cc
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/651fbf05db62190008737c47
😎 Deploy Preview https://deploy-preview-9377--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions
Copy link

github-actions bot commented Oct 6, 2023

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 55 🟢 97 🟢 92 🟢 100 🟠 89 Report
/docs/installation 🟠 74 🟢 98 🟢 92 🟢 100 🟠 89 Report

@slorber
Copy link
Collaborator

slorber commented Oct 6, 2023

Thanks ;)

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Oct 6, 2023
@slorber slorber merged commit df42d89 into facebook:main Oct 6, 2023
3 checks passed
@chillinPanda chillinPanda deleted the enhance-github-actions-yml-with-permissions branch October 10, 2023 07:28
This was referenced Oct 19, 2023
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.

None yet

3 participants