Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revert cache to use github.ref instead of github.sha #5460

Merged
merged 1 commit into from
May 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:
uses: actions/cache@v3
id: cache
with:
key: mkdocs-material-${{ github.sha }}
key: mkdocs-material-${{ github.ref }}
path: .cache
restore-keys: |
mkdocs-material-
Expand Down
11 changes: 7 additions & 4 deletions docs/publishing-your-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ contents:
python-version: 3.x
- uses: actions/cache@v3
with:
key: mkdocs-material-${{ github.sha }}
key: mkdocs-material-${{ github.ref }} # (3)!
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material # (3)!
- run: pip install mkdocs-material # (4)!
- run: mkdocs gh-deploy --force
```

Expand All @@ -53,7 +53,10 @@ contents:
2. At some point, GitHub renamed `master` to `main`. If your default branch
is named `master`, you can safely remove `main`, vice versa.

3. This is the place to install further [MkDocs plugins] or Markdown
3. The `github.ref` property assures that the cache will
update on each pull request merge.

4. This is the place to install further [MkDocs plugins] or Markdown
extensions with `pip` to be used during the build:

``` sh
Expand Down Expand Up @@ -85,7 +88,7 @@ contents:
python-version: 3.x
- uses: actions/cache@v3
with:
key: mkdocs-material-${{ github.sha }}
key: mkdocs-material-${{ github.ref }}
path: .cache
restore-keys: |
mkdocs-material-
Expand Down
2 changes: 1 addition & 1 deletion docs/setup/ensuring-data-privacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -501,7 +501,7 @@ carried out. You might want to:
python-version: 3.x
- uses: actions/cache@v3
with:
key: mkdocs-material-${{ github.sha }}
key: mkdocs-material-${{ github.ref }}
path: .cache
restore-keys: |
mkdocs-material-
Expand Down
2 changes: 1 addition & 1 deletion docs/setup/setting-up-social-cards.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ whether the social cards need to be regenerated. You might want to:
python-version: 3.x
- uses: actions/cache@v3
with:
key: mkdocs-material-${{ github.sha }}
key: mkdocs-material-${{ github.ref }}
path: .cache
restore-keys: |
mkdocs-material-
Expand Down