feat(cli): deploy command should allow customizing git config user.name / user.email in deployment branch (#9101) #9102

amdshrif · 2023-06-25T01:33:58Z

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

Fix #9101

Test Plan

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs

…e and user.email in deployment branch (facebook#9101)

facebook-github-bot · 2023-06-25T01:34:02Z

Hi @amdshrif!

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@meta.com. Thanks!

netlify · 2023-06-25T01:39:50Z

✅ [V2]

Name	Link
🔨 Latest commit	`88dffb7`
🔍 Latest deploy log	https://app.netlify.com/sites/docusaurus-2/deploys/649f012dbd5883000819002e
😎 Deploy Preview	https://deploy-preview-9102--docusaurus-2.netlify.app
📱 Preview on mobile	Toggle 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 · 2023-06-25T01:40:36Z

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	PWA	Report
/	🟠 70	🟢 97	🟢 92	🟢 100	🟠 89	Report
/docs/installation	🟠 69	🟢 100	🟢 92	🟢 100	🟠 89	Report

slorber

Do we really need this?

What prevents from replacing:

export GIT_USER_NAME="xyz"
export GIT_USER_EMAIL="my@email.com"
yarn deploy

With:

git config user.name "xyz"
git config user.email "my@email.com"
yarn deploy

slorber · 2023-06-29T10:26:49Z

packages/docusaurus/src/commands/deploy.ts

+    const gitUserName = process.env.GIT_USER_NAME;
+    if (gitUserName) {
+      shellExecLog(`git config user.name "${gitUserName}"`);
+    }
+
+    const gitUserEmail = process.env.GIT_USER_EMAIL;
+    if (gitUserEmail) {
+      shellExecLog(`git config user.email "${gitUserEmail}"`);
+    }


not super fan of having config side-effects like this, and features without documentation

amdshrif · 2023-06-29T22:11:13Z

Do we really need this?

What prevents from replacing:

export GIT_USER_NAME="xyz"
export GIT_USER_EMAIL="my@email.com"
yarn deploy

With:

git config user.name "xyz"
git config user.email "my@email.com"
yarn deploy

The suggested enhancement will only update the user.name and user.email locally on the repo level, while keeping the global git config as-is and I do not have to bother to keep switching between personal and work emails for every work I do on my machine.

The new enhancement works well with a local shell script that exports the other env variable settings all together.

env-setting.sh

export USE_SSH=true
export GIT_USER="amdshrif"
export CURRENT_BRANCH="deployment"
export GIT_USER_NAME="Ahmad Shrif"
export GIT_USER_EMAIL="ahmad.shrif@gmail.com"

source env-settings.sh

slorber · 2023-06-30T08:21:04Z

The suggested enhancement will only update the user.name and user.email locally on the repo level, while keeping the global git config as-is and I do not have to bother to keep switching between personal and work emails for every work I do on my machine.

Sorry, but I don't understand your answer.

The suggested enhancement will only update the user.name and user.email locally on the repo level, while keeping the global git config as-is

Isn't it the intended behavior in both cases?

I'll ask again:

Does the following work to deploy with the specified username/email, yes or not?

git config user.name "Ahmad Shrif"
git config user.email "ahmad.shrif@gmail.com"
yarn deploy

Have you tested it?

If it does not work, can you tell me what's the behavior you see, and what's the behavior you want?

slorber · 2023-06-30T08:34:15Z

Ok I understand the problem now, there are 2 repositories involved:

The current one
The one we clone for deployment (possibly a different one)

We need to set the config on the cloned deployment

I'm ok to merge this, but please add some documentation for these env variables

amdshrif · 2023-06-30T21:55:00Z

Ok I understand the problem now, there are 2 repositories involved:

The current one

The one we clone for deployment (possibly a different one)

We need to set the config on the cloned deployment

I'm ok to merge this, but please add some documentation for these env variables

Yes, that the is correct. Actually it is one repository and two branches, when we run yarn deploy it does a clone for the repository with the selected branch in a tmp folder and pushes the changes from there.

I will update the PR to update the docs and testing.

slorber · 2023-07-03T07:51:25Z

Thanks, added the docs to your pr already :)

feat:Enhance the deploy command to enable the setting of git user.nam…

eeec615

…e and user.email in deployment branch (facebook#9101)

amdshrif requested review from slorber, lex111 and Josh-Cena as code owners June 25, 2023 01:33

facebook-github-bot added the CLA Signed Signed Facebook CLA label Jun 25, 2023

slorber requested changes Jun 29, 2023

View reviewed changes

slorber mentioned this pull request Jun 29, 2023

Enhance the deploy command to enable the setting of git user.name and user.email in deployment branch #9101

Closed

2 tasks

Add docs

88dffb7

slorber changed the title ~~feat:Enhance the deploy command to enable the setting of git user.name and user.email in deployment branch (#9101)~~ feat(cli): deploy command should allow deployment with custom git config user.name / user.email in deployment branch (#9101) Jun 30, 2023

slorber changed the title ~~feat(cli): deploy command should allow deployment with custom git config user.name / user.email in deployment branch (#9101)~~ feat(cli): deploy command should allow customizing git config user.name / user.email in deployment branch (#9101) Jun 30, 2023

slorber added pr: new feature This PR adds a new API or behavior. to backport This PR is planned to be backported to a stable version of Docusaurus labels Jun 30, 2023

slorber merged commit 26ae416 into facebook:main Jul 3, 2023
30 of 31 checks passed

This was referenced Oct 19, 2023

chore: v3.0.0-rc.0 release #9418

Merged

chore: v3.0.0-rc.1 release #9453

Merged

slorber removed the to backport This PR is planned to be backported to a stable version of Docusaurus label Nov 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli): deploy command should allow customizing git config user.name / user.email in deployment branch (#9101) #9102

feat(cli): deploy command should allow customizing git config user.name / user.email in deployment branch (#9101) #9102

amdshrif commented Jun 25, 2023 •

edited by slorber

facebook-github-bot commented Jun 25, 2023

netlify bot commented Jun 25, 2023 •

edited

github-actions bot commented Jun 25, 2023 •

edited

slorber left a comment

slorber Jun 29, 2023

amdshrif commented Jun 29, 2023 •

edited

slorber commented Jun 30, 2023

slorber commented Jun 30, 2023

amdshrif commented Jun 30, 2023

slorber commented Jul 3, 2023

feat(cli): deploy command should allow customizing git config user.name / user.email in deployment branch (#9101) #9102

feat(cli): deploy command should allow customizing git config user.name / user.email in deployment branch (#9101) #9102

Conversation

amdshrif commented Jun 25, 2023 • edited by slorber

Pre-flight checklist

Motivation

Test Plan

Test links

Related issues/PRs

facebook-github-bot commented Jun 25, 2023

Action Required

Process

netlify bot commented Jun 25, 2023 • edited

✅ [V2]

github-actions bot commented Jun 25, 2023 • edited

⚡️ Lighthouse report for the deploy preview of this PR

slorber left a comment

Choose a reason for hiding this comment

slorber Jun 29, 2023

Choose a reason for hiding this comment

amdshrif commented Jun 29, 2023 • edited

slorber commented Jun 30, 2023

slorber commented Jun 30, 2023

amdshrif commented Jun 30, 2023

slorber commented Jul 3, 2023

amdshrif commented Jun 25, 2023 •

edited by slorber

netlify bot commented Jun 25, 2023 •

edited

github-actions bot commented Jun 25, 2023 •

edited

amdshrif commented Jun 29, 2023 •

edited