Skip to content

Commit

Permalink
Add a note to the README about CI
Browse files Browse the repository at this point in the history
  • Loading branch information
jimporter committed Sep 2, 2021
1 parent 81fc303 commit 21aab9c
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,25 @@ in mike, but since your built docs live on a git branch, it's still easy to
manage: check out your `gh-pages` branch (or wherever your built docs
live), and commit the necessary files to the root directory.

## Deploying via CI

Since mike just generates commits to an ordinary git branch, it should work
smoothly with your favorite CI system. However, you should keep in mind that
some CI systems make shallow clones of your repository, meaning that the CI job
won't have a local instance of your documentation branch to commit to. This will
naturally cause issues when trying to push the commit. This is easy to resolve
though. For Github Actions, you can simply disable shallow clones:

```yaml
jobs:
deploy-docs:
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0 # fetch all commits/branches
# ...
```

## For Theme Authors

If you'd like to provide support for mike in your theme, you just need to
Expand Down

0 comments on commit 21aab9c

Please sign in to comment.