https://github.com/eliashaeussler/cache-warmup-action
GitHub Action to warm up caches of URLs located in XML sitemaps
https://github.com/eliashaeussler/cache-warmup-action
cache-warmup github-action xml-sitemap
Last synced: 4 months ago
JSON representation
GitHub Action to warm up caches of URLs located in XML sitemaps
- Host: GitHub
- URL: https://github.com/eliashaeussler/cache-warmup-action
- Owner: eliashaeussler
- License: gpl-3.0
- Created: 2024-04-21T12:52:50.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-12-20T00:58:48.000Z (6 months ago)
- Last Synced: 2026-01-23T16:19:56.929Z (5 months ago)
- Topics: cache-warmup, github-action, xml-sitemap
- Language: Shell
- Homepage: https://cache-warmup.dev/
- Size: 78.1 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Cache Warmup GitHub Action
[](https://github.com/eliashaeussler/cache-warmup-action/actions/workflows/cgl.yaml)
[](https://github.com/eliashaeussler/cache-warmup-action/actions/workflows/tests.yaml)
[](https://github.com/eliashaeussler/cache-warmup-action/releases/latest)
GitHub Action for [`eliashaeussler/cache-warmup`](https://github.com/eliashaeussler/cache-warmup),
a library to warm up website caches of URLs located in XML sitemaps.
Read more in the [official documentation](https://cache-warmup.dev/).
## 🔥 Usage
> [!IMPORTANT]
> The action requires at least version **0.7.0** of the
> `eliashaeussler/cache-warmup` library.
Create a new workflow or add a new step to your existing workflow:
```yaml
# .github/workflows/cache-warmup.yaml
name: Cache Warmup
on:
push:
tags:
- '*'
jobs:
cache-warmup:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up environment
uses: shivammathur/setup-php@v2
with:
php-version: 8.3
coverage: none
- name: Run cache warmup
uses: eliashaeussler/cache-warmup-action@v1
with:
version: latest
sitemaps: |
https://www.example.com/sitemap.xml
https://www.example.com/de/sitemap.xml
urls: |
https://www.example.com/another-url
limit: 250
progress: true
verbosity: vvv
config: cache-warmup.json
```
## 📝 Inputs
The following inputs are currently available:
| Name | Description | Default | Required |
|-------------|----------------------------------------------------------------------------------------------------------|----------|----------|
| `version` | Version of the `eliashaeussler/cache-warmup` library to use (must be at least `0.7.0`) | `latest` | ✅ |
| `sitemaps` | URLs or local filenames of XML sitemaps to be warmed up, separated by newline | – | – |
| `urls` | Additional URLs to be warmed up, separated by newline | – | – |
| `limit` | Limit the number of URLs to be processed | `0` | – |
| `progress` | Show a progress bar during cache warmup | – | – |
| `verbosity` | Increase output verbosity (`v`, `vv` or `vvv`) | – | – |
| `config` | Path to an external configuration file (supported since v3 of the `eliashaeussler/cache-warmup` library) | – | – |
## 💬 Outputs
The following outputs are currently generated:
| Name | Description |
|-----------|-----------------------------------------------------------|
| `version` | Used version of the `eliashaeussler/cache-warmup` library |
## ⭐ License
This project is licensed under [GNU General Public License 3.0 (or later)](LICENSE.md).