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.

Sign up for GitHub

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

Jump to bottom

feat(v2): docusaurus deploy: ability to configure port in git url #4545

Merged
merged 7 commits into from
Apr 9, 2021
Merged

feat(v2): docusaurus deploy: ability to configure port in git url #4545

merged 7 commits into from
Apr 9, 2021

Conversation

talesporto
Copy link
Contributor

Motivation

To have a way to deploy it to a github which is not running under the port 22.

Have you read the Contributing Guidelines on pull requests?

(Write your answer here.)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)

Related PRs

(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)

@facebook-github-bot
Copy link
Contributor

Hi @talesporto!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Apr 1, 2021
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

@github-actions
Copy link

github-actions bot commented Apr 1, 2021 •
edited
Loading

⚡️ 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-4545--docusaurus-2.netlify.app/

@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

slorber
slorber requested changes Apr 1, 2021
View reviewed changes
Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

To understand better why we need these changes, can you please let me know which problem you are facing and the exact steps to reproduce this problem myself and see that your solution fixes that problem.

There is also a linter/prettierr error

website/docs/deployment.mdx Show resolved Hide resolved
packages/docusaurus/src/commands/deploy.ts Outdated Show resolved Hide resolved
packages/docusaurus/src/commands/deploy.ts Outdated Show resolved Hide resolved
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

@talesporto
Fixing some mistakes
cc3971d 
Documenting

Adding githubPort documentation on docusaurus.config.js.

Addind SSH protocol prefix. ssh://

Using the default protocol port instead of define it on the code.

Prettify.
@talesporto
Fixing some mistakes
8889bed 
Documenting

Adding githubPort documentation on docusaurus.config.js.

Addind SSH protocol prefix. ssh://

Using the default protocol port instead of define it on the code.

Prettify.
@talesporto
Copy link
Contributor Author

Thanks

To understand better why we need these changes, can you please let me know which problem you are facing and the exact steps to reproduce this problem myself and see that your solution fixes that problem.

There is also a linter/prettierr error

Just to explain better what is the case here.

I'm working with Docusaurus to be published inside BitBucket which is using a different SSH port.
Then there is no way to me to use yarn deploy to deploy it throw SSH.
BTW, it is working through HTTP. But I need to do it via SSH.

I just want a way to configure the port used under SSH call which today is the protocol's default port.

@talesporto talesporto changed the title Creating a way to configure the port used on the guthub deploy. Creating a way to configure the port used on the github deploy. Apr 1, 2021
@talesporto talesporto requested a review from slorber April 6, 2021 07:24
slorber
slorber requested changes Apr 6, 2021
View reviewed changes
Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does not feel 100% retro compatible to me for users not specifying a port.

packages/docusaurus/src/commands/deploy.ts Outdated Show resolved Hide resolved
@netlify
Copy link

netlify bot commented Apr 9, 2021

[V2]

Built without sensitive environment variables with commit 664d6f2

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

@netlify
Copy link

netlify bot commented Apr 9, 2021 •
edited
Loading

[V2]

Built without sensitive environment variables with commit 976b159

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

@slorber
Copy link
Collaborator

slorber commented Apr 9, 2021

Thanks, that looks like a safer change to me now ;)

@slorber slorber changed the title Creating a way to configure the port used on the github deploy. feat(v2): docusaurus deploy: ability to configure port in git url Apr 9, 2021
@slorber slorber added the pr: new feature This PR adds a new API or behavior. label Apr 9, 2021
@slorber slorber merged commit e99bb43 into facebook:master Apr 9, 2021
@talesporto
Copy link
Contributor Author

Hi @slorber,

Thank you for the approval.
When can I expect to see it released? And in which version?

@talesporto talesporto deleted the patch-1 branch April 19, 2021 07:32
@slorber
Copy link
Collaborator

slorber commented Apr 19, 2021

alpha 73 has been released already, add release notifications on this repo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@slorber slorber slorber requested changes

@lex111 lex111 Awaiting requested review from lex111

Assignees
No one assigned
Labels
CLA Signed Signed Facebook CLA pr: new feature This PR adds a new API or behavior.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@talesporto @facebook-github-bot @slorber