-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
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): remove npx and use github action to configure ssh key #4263
Conversation
[V1] Deploy preview failure Built without sensitive environment variables with commit 31d14c7 https://app.netlify.com/sites/docusaurus-1/deploys/60337e2bd245ee00073ccffb |
Size Change: 0 B Total Size: 543 kB ℹ️ View Unchanged
|
Deploy preview for docusaurus-2 ready! Built without sensitive environment variables with commit 31d14c7 |
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4263--docusaurus-2.netlify.app/classic/ |
LGTM, thanks for updating this doc :) Just want to confirm, is it's time consuming to review this new workflow, is it something you use anywhere where I could see it in action? |
Sure! I'm glad to help :) |
seems to work, thanks :) |
I got preoccupied elsewhere, but was going to contribute an alternative workflow myself. The git email typo I also noticed, but used the official github-actions bots email so the account that is associated to the commits is valid, and instead of SSH, I used a different action that uses the Github Actions workflow token, no key needs to be provided at all then (assuming you're pushing to a branch on the same repo). Is there any interest for either of those additions? This PR was probably good enough of an improvement (the original content was overly complicated for a user to get Docusaurus publishing to GH pages). |
@polarathene I'm not one of the maintainers of this repo but any improvement sounds good to me.. |
Yes any improvement is good, and I think most websites will want to deploy to GH pages to their own repo and would be appreciated a very simple workflow. We have cases where someone wants to push to another repo through, that might still worth adding a note for those use-cases. I'm not very familiar with GH pages and the best workflow to support, so it's. hard for me to recommend anything, as most of our sites are on Netlify. We often have GH pages issues that I don't know how to solve without careful inspection, such as recently #4336 |
@slorber I've had a fair bit of experience with Github Pages and Github Actions/Workflows lately. So hopefully I was able to help solve that issue :)
Sure! Although this is about deploying to Github Pages, having the CI for a project deploy to another git project entirely seems a different use-case? (usually you'd just have a
|
Motivation
Since
npx docusaurus
uses the first version of docusaurus, this command doesn't work.I've also changed the custom SSH key implementation to use a generic github action.
Have you read the Contributing Guidelines on pull requests?
Yes.
Test Plan
Irrelevant, this is a docs fix.