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): remove npx and use github action to configure ssh key #4263

Merged
merged 2 commits into from
Feb 22, 2021

Conversation

MatanBobi
Copy link
Contributor

@MatanBobi MatanBobi commented Feb 22, 2021

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.

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Feb 22, 2021
@netlify
Copy link

netlify bot commented Feb 22, 2021

@github-actions
Copy link

github-actions bot commented Feb 22, 2021

Size Change: 0 B

Total Size: 543 kB

ℹ️ View Unchanged
Filename Size Change
website/build/assets/css/styles.********.css 86.6 kB 0 B
website/build/assets/js/main.********.js 370 kB 0 B
website/build/blog/2017/12/14/introducing-docusaurus/index.html 60.5 kB 0 B
website/build/docs/introduction/index.html 235 B 0 B
website/build/index.html 25.6 kB 0 B

compressed-size-action

@netlify
Copy link

netlify bot commented Feb 22, 2021

Deploy preview for docusaurus-2 ready!

Built without sensitive environment variables with commit 31d14c7

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

@github-actions
Copy link

github-actions bot commented Feb 22, 2021

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 84
🟢 Accessibility 96
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-4263--docusaurus-2.netlify.app/classic/

@MatanBobi MatanBobi changed the title docs(deployment): remove npx and fix github email docs(deployment): remove npx and use github action to configure ssh key Feb 22, 2021
@slorber
Copy link
Collaborator

slorber commented Feb 22, 2021

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?

@slorber slorber changed the title docs(deployment): remove npx and use github action to configure ssh key docs(v2): remove npx and use github action to configure ssh key Feb 22, 2021
@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Feb 22, 2021
@MatanBobi
Copy link
Contributor Author

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 :)
I've just implemented it today on a POC we're working on, you can see it here:
https://github.com/nielsen-oss/docs/blob/master/.github/workflows/documentation.yml

@slorber
Copy link
Collaborator

slorber commented Feb 22, 2021

seems to work, thanks :)

@slorber slorber merged commit 967386f into facebook:master Feb 22, 2021
@lex111 lex111 added this to the v2.0.0-alpha.71 milestone Mar 1, 2021
@polarathene
Copy link
Contributor

polarathene commented Mar 3, 2021

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).

@MatanBobi
Copy link
Contributor Author

@polarathene I'm not one of the maintainers of this repo but any improvement sounds good to me..

@slorber
Copy link
Collaborator

slorber commented Mar 4, 2021

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

@polarathene
Copy link
Contributor

polarathene commented Mar 12, 2021

@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 :)

We have cases where someone wants to push to another repo through, that might still worth adding a note for those use-cases.

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 gh-pages branch on the same source repo)

I'll create a PR with my contribution and it can be reworked as appropriate. Might be a useful case for Tabs? EDIT: PR available! 😀

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.

5 participants