Documenter.jl failing to push -- I'm a bit lost

General Usage
1

Hey,

A friend of mine started out on a package without asking PkgTemplate to produce online documentation (there were no CI at all on the whole package). I tried to port some of it from other packages that I have but I clearly missed something, ending up with a failing CI here : Create Project.toml · FJRubio67/HazReg.jl@3bdc26b · GitHub that says:

Error: Failed to push:
  exception = 
    failed process: Process(setenv(`/home/runner/.julia/artifacts/116cad2e78d976b340491c12382ab1531da41460/bin/git push -q upstream HEAD:gh-pages`,["PATH=/home/runner/.julia/artifacts/2bce74229f51de64c33433272240af5734619b33/bin:/home/runner/.julia/artifacts/69903d1a57355b6e78750aac3a8b3fddab87180f/bin:/home/runner/.julia/artifacts/116cad2e78d976b340491c12382ab1531da41460/bin:/opt/hostedtoolcache/julia/1.10.2/x64/bin:/snap/bin:/home/runner/.local/bin:/opt/pipx_bin:/home/runner/.cargo/bin:/home/runner/.config/composer/vendor/bin:/usr/local/.ghcup/bin:/home/runner/.dotnet/tools:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin", "DOTNET_SKIP_FIRST_TIME_EXPERIENCE=1", "GITHUB_RUN_NUMBER=6", "GITHUB_REF_NAME=main", "RUNNER_ARCH=X64", "PERFLOG_LOCATION_SETTING=RUNNER_PERFLOG", "GKS_ENCODING=utf8", "STATS_TIS=mining", "LD_LIBRARY_PATH=/opt/hostedtoolcache/julia/1.10.2/x64/bin/../lib/julia:/home/runner/.julia/artifacts/2bce74229f51de64c33433272240af5734619b33/lib:/home/runner/.julia/artifacts/69903d1a57355b6e78750aac3a8b3fddab87180f/lib:/home/runner/.julia/artifacts/e4e0c1bb8f52a7a9d586af15bc1713e83c1f42af/lib:/opt/hostedtoolcache/julia/1.10.2/x64/bin/../lib/julia:/opt/hostedtoolcache/julia/1.10.2/x64/bin/../lib", "GOROOT_1_20_X64=/opt/hostedtoolcache/go/1.20.14/x64", "ACCEPT_EULA=Y", "GKS_USE_CAIRO_PNG=true", "GOROOT_1_21_X64=/opt/hostedtoolcache/go/1.21.8/x64", "ANT_HOME=/usr/share/ant", "RUNNER_USER=runner", "LEIN_HOME=/usr/local/lib/lein", "GITHUB_REPOSITORY_ID=741022292", "GITHUB_ACTOR=FJRubio67", "GITHUB_WORKFLOW_REF=FJRubio67/HazReg.jl/.github/workflows/CI.yml@refs/heads/main", "ANDROID_NDK_LATEST_HOME=/usr/local/lib/android/sdk/ndk/26.2.11394342", "SYSTEMD_EXEC_PID=606", "RUNNER_ENVIRONMENT=github-hosted", "OPENBLAS_DEFAULT_NUM_THREADS=1", "GIT_TEMPLATE_DIR=/home/runner/.julia/artifacts/116cad2e78d976b340491c12382ab1531da41460/share/git-core/templates", "USER=runner", "CONDA=/usr/share/miniconda", "JULIA_PKG_SERVER_REGISTRY_PREFERENCE=eager", "VCPKG_INSTALLATION_ROOT=/usr/local/share/vcpkg", "GITHUB_REF_PROTECTED=false", "GKSwstype=", "GITHUB_API_URL=https://api.github.com", "GITHUB_RUN_ATTEMPT=2", "GITHUB_ACTIONS=true", "STATS_V3PS=true", "GITHUB_SHA=3bdc26b2c0af0ac1c94a77c6b36d820cb21ae98b", "JAVA_HOME=/usr/lib/jvm/temurin-11-jdk-amd64", "STATS_EXT=true", "ANDROID_SDK_ROOT=/usr/local/lib/android/sdk", "SWIFT_PATH=/usr/share/swift/usr/bin", "GITHUB_ENV=/home/runner/work/_temp/_runner_file_commands/set_env_f1d32df8-bb6f-41fb-9c6d-576100711ae0", "JAVA_HOME_17_X64=/usr/lib/jvm/temurin-17-jdk-amd64", "GITHUB_ACTION_PATH=/home/runner/work/_actions/julia-actions/julia-docdeploy/v1", "RUNNER_PERFLOG=/home/runner/perflog", "RUNNER_NAME=GitHub Actions 4", "EDGEWEBDRIVER=/usr/local/share/edge_driver", "GITHUB_RUN_ID=8327945775", "GHCUP_INSTALL_BASE_PREFIX=/usr/local", "ImageOS=ubuntu22", "NVM_DIR=/home/runner/.nvm", "GITHUB_HEAD_REF=", "GITHUB_RETENTION_DAYS=90", "GITHUB_SERVER_URL=https://github.com", "GITHUB_OUTPUT=/home/runner/work/_temp/_runner_file_commands/set_output_f1d32df8-bb6f-41fb-9c6d-576100711ae0", "STATS_UE=true", "GITHUB_JOB=docs", "DEBIAN_FRONTEND=noninteractive", "RUNNER_TRACKING_ID=github_baa067e7-fb1b-42e9-b172-57302dd5d2e4", "RUNNER_TOOL_CACHE=/opt/hostedtoolcache", "HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS=3650", "AZURE_EXTENSION_DIR=/opt/az/azcliextensions", "HOMEBREW_NO_AUTO_UPDATE=1", "CHROMEWEBDRIVER=/usr/local/share/chromedriver-linux64", "GITHUB_ACTION_REPOSITORY=", "GITHUB_WORKFLOW=CI", "GITHUB_ACTION=__julia-actions_julia-docdeploy", "HOME=/home/runner", "JAVA_HOME_8_X64=/usr/lib/jvm/temurin-8-jdk-amd64", "GITHUB_EVENT_PATH=/home/runner/work/_temp/_github_workflow/event.json", "GITHUB_STEP_SUMMARY=/home/runner/work/_temp/_runner_file_commands/step_summary_f1d32df8-bb6f-41fb-9c6d-576100711ae0", "SGX_AESM_ADDR=1", "GITHUB_REF=refs/heads/main", "GIT_EXEC_PATH=/home/runner/.julia/artifacts/116cad2e78d976b340491c12382ab1531da41460/libexec/git-core", "GITHUB_REPOSITORY=FJRubio67/HazReg.jl", "INVOCATION_ID=453c7c4a4e8141b98097159943f

Could someone please gently take a look and tell us what is going on ?

1 Like
2

I think your github action does not have write permissions so the git command fails.

Wrong but easy and common solution: go to settings > actions for your repository and give write permissions to your actions. It seems it is bad practice, especially in terms of security.

Proper solution: inside of the yml file defining your github action add a permissions line and enumerate the write permission.

2 Likes
3

Humm… It worked, everything got pushed to GitHub pages branch, but the website is still 404. Maybe we missed something else ?

4

As always, when something is not happening in GitHub Actions (or any other CI service), try to have a look at the logs. Your page-build-deployment jobs are failing: pages-build-deployment · Workflow runs · FJRubio67/HazReg.jl · GitHub

5

Hum… Looks like GitHub actions is trying to run Jekyll, which I guess we do not want here.