mirror of
https://github.com/rust-lang/cargo.git
synced 2025-09-25 11:14:46 +00:00

The current contrib deploy-hook fails if there is no `gh-pages` branch. Change the CI order to disregard the old `gh-pages` branch first. The `contrib` deploy-hook always creates a fresh `gh-pages` commit and pushes it out. However, currently it relies on the old `gh-pages` branch to exist, since it does not ignore errors when pruning it. Fortunately, the code always creates a new orphan branch, since it does not want to keep history for deployments. Therefore, we can simply use: `git worktree --orphan -B <branch> <path>` This will ensure to always create an orphan branch named `<branch>`, and override an existing branch if it exists (see `-b` vs `-B`). Hence, there is no need for us to prune the old branch, anymore. Since we will recreate the branch on every push, we have to explicitly specify the remote to push to. We no longer set up branch tracking.
37 lines
974 B
YAML
37 lines
974 B
YAML
name: Contrib Deploy
|
|
on:
|
|
push:
|
|
branches:
|
|
- master
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
deploy:
|
|
permissions:
|
|
contents: write # for Git to git push
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
- name: Install mdbook
|
|
run: |
|
|
mkdir mdbook
|
|
curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.27/mdbook-v0.4.27-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
|
|
echo `pwd`/mdbook >> $GITHUB_PATH
|
|
- name: Deploy docs
|
|
run: |
|
|
cd src/doc/contrib
|
|
mdbook build
|
|
# Override previous ref to avoid keeping history.
|
|
git worktree add --orphan -B gh-pages gh-pages
|
|
git config user.name "Deploy from CI"
|
|
git config user.email ""
|
|
cd gh-pages
|
|
mv ../book contrib
|
|
git add contrib
|
|
git commit -m "Deploy $GITHUB_SHA to gh-pages"
|
|
git push origin +gh-pages
|