2.0.0-beta.22 breaks cross-repo deploy to GitHub Pages #7744

yechs · 2022-07-08T19:46:47Z

Have you read the Contributing Guidelines on issues?

I have read the Contributing Guidelines on issues.

Prerequisites

I'm using the latest version of Docusaurus.
I have tried the npm run clear or yarn clear command.
I have tried rm -rf node_modules yarn.lock package-lock.json and re-installing packages.
I have tried creating a repro with https://new.docusaurus.io.
I have read the console error message carefully (if applicable).

Description

Updating to docusaurus v2.0.0-beta.22 breaks my deployment to GitHub Pages.

The relevant commandline error follows:

[INFO] `git commit -m "Deploy website - based on 6f67bb9205e05e2d37ba6368e30774c48e6db78d"` code: 0
To github.com:yechs/website.git
 ! [remote rejected] master -> master (shallow update not allowed)
error: failed to push some refs to 'github.com:yechs/website.git'
[INFO] `git push --force origin master` code: 1
[ERROR] Deployment of the build output failed.
[ERROR] Error: Running "git push" command failed. Does the GitHub user account you are using have push access to the repository?
    at runDeploy (/Users/yeshu/Coding/Personal/website/node_modules/@docusaurus/core/lib/commands/deploy.js:168:19)
    at async Command.deploy (/Users/yeshu/Coding/Personal/website/node_modules/@docusaurus/core/lib/commands/deploy.js:189:13)
error Command failed with exit code 1.

According to the command line output, it looks like a shallow update problem. However, the weird thing is, docusaurus has been doing shallow clone deployments for almost a year now and has never failed before.
Relevant PR: #5748

Logs

If you want a full log, there is one available from GitHub Actions (https://github.com/yechs/website/runs/7256462347)

And here is the successful log running yarn deploy on v2.0.0-beta.21 three days ago (https://github.com/yechs/website/runs/7204294330)

Reproduction

Just to rule out the variables of GitHub Actions or GitHub changing their behavior:

I've ran yarn deploy locally on v2.0.0-beta.22 and it failed with the same message.
I have also manually reverted back to v2.0.0-beta.21 and ran yarn deploy, which functioned perfectly normal. (Note that it is doing the same shallow clone)

Reproducible demo

https://github.com/yechs/website/

Steps to reproduce

Run yarn deploy
Observe that it fails
git checkout 193d6e0 to go back to docusaurus v2.0.0-beta.21
Run yarn to install dependencies
Run yarn deploy
Observe that it succeeds

Expected behavior

Deployment continues to function as in v2.0.0-beta.21

Actual behavior

Deployment fails. See log from GitHub Actions.

Your environment

Public source code:
- Source code at https://github.com/yechs/website/
- Deployed to https://github.com/yechs/yechs.github.io/
Public site URL:
Docusaurus version used:
- v2.0.0-beta.22
Environment name and version (e.g. Chrome 89, Node.js 16.4):
Operating system and version (e.g. Ubuntu 20.04.2 LTS):
- Ubuntu (GitHub Actions) with Node v16
- MacOS with Node v16.15.1
- Arch Linux with Node v16.14.2

Self-service

I'd be willing to fix this bug myself.

The text was updated successfully, but these errors were encountered:

Josh-Cena · 2022-07-09T03:28:12Z

Looks like a bug with #7702? Could you try running 0.0.0-5163?

yechs · 2022-07-09T03:42:48Z

Yes deploying with 0.0.0-5163 is fine. Could be related to this issue

yechs · 2022-07-09T03:47:14Z

I have taken a look at the PR content. It may be possible that by copying over local .git/config, the remote origin url is also copied over.

However, I'm deploying to a different repo other than the source repo, which has a different "origin" url. This causes a problem. When coping over the git config file, the destination origin is also overwritten. Hence, git will push to a different repository and naturally fail.

Josh-Cena · 2022-07-09T03:56:42Z

cc @ghostsquad Any ideas?

yechs · 2022-07-09T04:00:19Z

In my humble opinion, it would be counter-intuitive to copy git configs during deployment.

It should be up to the CI to set up the desired git configuration environment, either via environment variables or, in the case of more advanced configs such as gpg signing key, via global configuration

ghostsquad · 2022-07-09T04:56:22Z

The problem is that I don't want to just deploy via CI. A local deployment should be valid as well. Let me look at the error...

Josh-Cena · 2022-07-09T04:58:07Z

A local deployment should be valid as well.

You can always change your deploy script in package.json.

ghostsquad · 2022-07-09T04:59:50Z

I can submit a pull request to add a git configuration map to the main config file that is used for this operation. It would allow arbitrary configuration to be applied after the clone operation.

ghostsquad · 2022-07-09T05:10:00Z

A local deployment should be valid as well.

You can always change your deploy script in package.json.

literally the only thing I need to change is some simple stuff like my email, gpg key, etc. It shouldn't be necessary to reproduce the entirety of what's already being done just to inject some git config.

yechs · 2022-07-09T05:30:53Z

literally the only thing I need to change is some simple stuff like my email, gpg key, etc. It shouldn't be necessary to reproduce the entirety of what's already being done just to inject some git config.

Here is an email thread from the Git developers that may be interesting for you to read. (https://lore.kernel.org/git/xmqqwnm12xv7.fsf@gitster.g/T/)

It would be a lot simpler to just use environment variables.
There exists built-in variables for setting user.email and user.name. Then, ALL config fields can be set via the GIT_CONFIG_KEY_<n> and GIT_CONFIG_VALUE_<n> env vars (read manual)
So, for the signingkey, you can set GIT_CONFIG_COUNT=1 GIT_CONFIG_KEY_0=user.signingkey GIT_CONFIG_VALUE_0=<your keyID>

Alternatively, you can also use the conditional includes feature of git config.

Both methods seem to be more intuitive (i.e. less hacks) solutions to your problem.
In the worst case, you can always use patch-packages to patch the deployment commands for your own.

This reverts commit ee376d1. All git config fields can be set via the GIT_CONFIG_KEY_<n> and GIT_CONFIG_VALUE_<n> env vars. Ref: https://git-scm.com/docs/git-config#Documentation/git-config.txt-GITCONFIGCOUNT Alternatively, you can also use the conditional includes feature of git config. Ref: https://git-scm.com/docs/git-config#_conditional_includes resolves facebook#7744

ghostsquad · 2022-07-09T05:39:55Z

@yechs I think you are right. I'll file a revert for this.

This reverts commit ee376d1. All git config fields can be set via the GIT_CONFIG_KEY_<n> and GIT_CONFIG_VALUE_<n> env vars. Ref: https://git-scm.com/docs/git-config#Documentation/git-config.txt-GITCONFIGCOUNT Alternatively, you can also use the conditional includes feature of git config. Ref: https://git-scm.com/docs/git-config#_conditional_includes fixes facebook#7744

silverqx · 2022-07-10T13:29:31Z

I have upgraded to the beta22 now and I can't deploy too, exactly the same problem.

yechs · 2022-07-10T18:39:42Z

I have upgraded to the beta22 now and I can't deploy too, exactly the same problem.

I guess you'll have to wait until #7750 gets merged and hopefully they'll release a hotfix soon enough

slorber · 2022-07-12T12:07:06Z

Until next bugfix release, you should be able to use the latest canary version

silverqx · 2022-07-12T13:02:27Z

I will wait for the beta.23 release.

silverqx · 2022-07-16T18:23:51Z

Fixed in rc1, deploying works well again thx

veris-amoghbanta · 2022-08-04T16:45:06Z

Still getting this error in 2.0.1.

[ERROR] Deployment of the build output failed.
[ERROR] Error: Running "git push" command failed. Does the GitHub user account you are using have push access to the repository?
    at runDeploy (.../node_modules/@docusaurus/core/lib/commands/deploy.js:158:19)
    at async Command.deploy (.../node_modules/@docusaurus/core/lib/commands/deploy.js:179:13)

Version 2.0.1 breaks the github actions deploy. Based on the issue below, docusaurus was working on 2.0.0-rc1. This commit downgrades docusuarus to the latter version. See: facebook/docusaurus#7744

Version 2.0.1 breaks the github actions deploy. Based on the issue below, docusaurus was working on 2.0.0-rc.1. This commit downgrades docusuarus to the latter version. See: facebook/docusaurus#7744

silverqx · 2022-08-05T16:09:57Z

I have deployed two times using v2.0.1 and don't have any problems.

Version 2.0.1 breaks the github actions deploy. Based on the issue below, docusaurus was working on 2.0.0-rc.1. This commit downgrades docusuarus to the latter version. See: facebook/docusaurus#7744

yechs added bug An error in the Docusaurus core causing instability or issues with its execution status: needs triage This issue has not been triaged by maintainers labels Jul 8, 2022

Josh-Cena added status: needs more information There is not enough information to take action on the issue. and removed status: needs triage This issue has not been triaged by maintainers labels Jul 9, 2022

Josh-Cena removed the status: needs more information There is not enough information to take action on the issue. label Jul 9, 2022

yechs changed the title ~~2.0.0-beta.22 breaks deploy to GitHub Pages (shallow update not allowed)~~ 2.0.0-beta.22 breaks cross-repo deploy to GitHub Pages Jul 9, 2022

ghostsquad mentioned this issue Jul 9, 2022

fix(deploy): revert "feat(deploy): copy local git config to tmp repo (#7702)" #7750

Merged

3 tasks

gao-sun mentioned this issue Jul 12, 2022

ci: fix deploy logto-io/docs#155

Merged

slorber closed this as completed in #7750 Jul 12, 2022

joshklop mentioned this issue Aug 5, 2022

Downgrade docusaurus NethermindEth/juno#326

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

2.0.0-beta.22 breaks cross-repo deploy to GitHub Pages #7744

2.0.0-beta.22 breaks cross-repo deploy to GitHub Pages #7744

yechs commented Jul 8, 2022 •

edited

Josh-Cena commented Jul 9, 2022 •

edited

yechs commented Jul 9, 2022

yechs commented Jul 9, 2022 •

edited

Josh-Cena commented Jul 9, 2022

yechs commented Jul 9, 2022

ghostsquad commented Jul 9, 2022

Josh-Cena commented Jul 9, 2022

ghostsquad commented Jul 9, 2022

ghostsquad commented Jul 9, 2022

yechs commented Jul 9, 2022

ghostsquad commented Jul 9, 2022

silverqx commented Jul 10, 2022

yechs commented Jul 10, 2022

slorber commented Jul 12, 2022

silverqx commented Jul 12, 2022

silverqx commented Jul 16, 2022

veris-amoghbanta commented Aug 4, 2022

silverqx commented Aug 5, 2022

2.0.0-beta.22 breaks cross-repo deploy to GitHub Pages #7744

2.0.0-beta.22 breaks cross-repo deploy to GitHub Pages #7744

Comments

yechs commented Jul 8, 2022 • edited

Have you read the Contributing Guidelines on issues?

Prerequisites

Description

Logs

Reproduction

Reproducible demo

Steps to reproduce

Expected behavior

Actual behavior

Your environment

Self-service

Josh-Cena commented Jul 9, 2022 • edited

yechs commented Jul 9, 2022

yechs commented Jul 9, 2022 • edited

Josh-Cena commented Jul 9, 2022

yechs commented Jul 9, 2022

ghostsquad commented Jul 9, 2022

Josh-Cena commented Jul 9, 2022

ghostsquad commented Jul 9, 2022

ghostsquad commented Jul 9, 2022

yechs commented Jul 9, 2022

ghostsquad commented Jul 9, 2022

silverqx commented Jul 10, 2022

yechs commented Jul 10, 2022

slorber commented Jul 12, 2022

silverqx commented Jul 12, 2022

silverqx commented Jul 16, 2022

veris-amoghbanta commented Aug 4, 2022

silverqx commented Aug 5, 2022

yechs commented Jul 8, 2022 •

edited

Josh-Cena commented Jul 9, 2022 •

edited

yechs commented Jul 9, 2022 •

edited