Why?
I've been struggling for a while to find a way to clear the CDN cache using GitHub Actions. I tried a few different methods, but none of them worked quite right. Finally, I found the solution!
The solution is to use the Invalid CDN cache on GCP action from the GitHub Marketplace. This action makes it easy to add CDN cache invalidation to your pipeline.
Setup
Before using this action, you must first use the google-github-actions/auth
action to authenticate to Google Cloud.
Required inputs:
-
load-balancer-name
: The name of the load balancer. This value can be found in the Google Cloud Console. -
path
: The path to the content that you want to invalidate. This value must be a valid URL path. For example:- to invalidate the cache for the
/index.html
file, you would set thepath
input to/index.html
. - to invalidate the whole directory, you would set the
path
input to/images/*
. - to invalidate everything, you would set the
path
input to/*
.
- to invalidate the cache for the
Optional inputs:
-
host
: The hostname of the CDN endpoint. If you do not specify a hostname, the action will use the default hostname for the load balancer. -
gcloud_version
: Version of the Cloud SDK to install. If unspecified or set to "latest", the latest available gcloud SDK version for the target platform will be installed. Example: "290.0.1". -
gcloud_component
: Version of the Cloud SDK components to install and use.
Example usage:
name: Invalidate Google Cloud CDN Cache
on:
push:
branches: [ main ]
jobs:
invalidate-cache:
runs-on: ubuntu-latest
steps:
- name: Authenticate to Google Cloud
uses: google-github-actions/auth@v2
with:
- name: Invalid CDN cache on GCP
uses: stefanodotit/github-actions-invalidate-gcp-cdn@v1
with:
load_balancer_name: LOAD_BALANCER_NAME
path: '/path/to/invalid/*'
I highly recommend this action to anyone who needs to clear their CDN cache using GitHub Actions.
Additional notes:
- You can find more information about the action on the GitHub Marketplace: https://github.com/marketplace/actions/invalid-cdn-cache-on-gcp
- You can also find more information about GCP's CDN API on the Google Cloud documentation website: https://cloud.google.com/cdn
I hope this helps!
P.S. If you have any other questions, please feel free to leave a comment below.
Top comments (0)