13 Commits

Author SHA1 Message Date
David Rheinsberg
1d261830a0 ci/contrib: do not fail on missing gh-pages
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.
2023-10-17 14:28:23 +02:00
renovate[bot]
94024bf5e4
chore(deps): update actions/checkout action to v4 2023-10-01 03:07:56 +00:00
Weihang Lo
3e1f60fcb0
chore: bump mdbook to 0.4.27
Previously mdbook was bumped in #11646 for contrib.yml worflow
but main.yaml workflow. This makes the two in sync and also
upgrades to the latest 0.4.27. (Though there is nothing really
changed for application users as us)
2023-02-15 11:37:35 +00:00
Enyium
0263ef4379 Enable smart punctuation in mdBook. 2023-02-14 08:15:29 +01:00
jofas
7bd86d207c removed steps for api doc creation from action 2023-01-12 14:03:30 +01:00
Weihang Lo
ba3d2e981b
ci: update toolchain for building api doc 2022-09-22 21:40:27 +01:00
Weihang Lo
1c82d9c8c3 Make CI build API doc 2022-08-25 12:19:49 +01:00
naveen
a4ac0438a2 chore: Set permissions for GitHub actions
Restrict the GitHub token permissions only to the required ones; this way, even if the attackers will succeed in compromising your workflow, they won’t be able to do much.

- Included permissions for the action. https://github.com/ossf/scorecard/blob/main/docs/checks.md#token-permissions

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions

https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs

[Keeping your GitHub Actions and workflows secure Part 1: Preventing pwn requests](https://securitylab.github.com/research/github-actions-preventing-pwn-requests/)

Signed-off-by: naveen <172697+naveensrinivasan@users.noreply.github.com>
2022-07-03 00:31:05 +00:00
Eliaz Bobadilla
095f403f3e tools: update checkout action on CI
https://github.com/actions/checkout\#whats-new
2022-03-30 12:11:50 -05:00
Eric Huss
ad328f44c6 Bump mdbook version for contrib guide. 2021-06-02 15:41:47 -07:00
Eric Huss
352f828903 Update mdbook 2021-01-04 07:28:26 -08:00
Eric Huss
d1e44819a5 Update deprecated GitHub add-path in workflows. 2020-10-08 09:17:12 -07:00
Eric Huss
4d40ef4ef4 Add contributor guide. 2020-09-18 14:01:51 -07:00