Cloudflare Delete Deployments Action

Using the Action

Inputs

Name	Description	Required	Default
token	The Cloudflare API token to use for authentication.	Yes
project	The Cloudflare project name to delete deployments from.	Yes
account	The Cloudflare account id to delete deployments from.	Yes
branch	The branch to delete deployments from.	Yes
since	Filter deployments to those deployed after since, in ISO8601 format	No	1970-01-01
deployment_trigger	Filter deployments to those deployed by the given deployment trigger	No

Token

Use the worker template as a base when generating the token in the Cloudflare dashboard.

Example usage

uses: go-fjords/cloudflare-delete-deployments-action@main
with:
  token: ${{ secrets.CLOUDFLARE_TOKEN }}
  project: <your-project-name>
  account: <your-account-id>
  branch: <your-branch-name>

Example workflow to delete deployments for a given PR on merge or close:

name: Pull Request Closed
concurrency:
  group: pr_${{ github.event.pull_request.number }}
  cancel-in-progress: true
on:
  pull_request:
    types:
      - closed
      - merged

jobs:
  - name: Delete Cloudflare Preview Deployment
    runs-on: ubuntu-latest
    steps:
      - uses: go-fjords/cloudflare-delete-deployments-action@main
        with:
          token: ${{ secrets.CLOUDFLARE_TOKEN }}
          project: <your-project-name>
          account: <your-account-id>
          branch: ${{ github.head_ref }}

Development

Install the dependencies:

npm install

Run the tests ✔️

$ npm test
> jest

Browserslist: caniuse-lite is outdated. Please run:
  npx browserslist@latest --update-db
  Why you should do it regularly: https://github.com/browserslist/browserslist#browsers-data-updating
Running Cloudflare Deployments Delete Action
Fetching deployments for project undefined and branch undefined
::group::Fetching deployments
Fetching page 1 of deployments
::endgroup::
Found 1 deployments in total
Deleting 0 deployments matching branch undefined
::group::Deleted Deployments
::endgroup::
Finished Cloudflare Deployments Delete Action
 PASS  ./main.test.js
  ✓ test main (3 ms)

Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        0.416 s, estimated 1 s

Package for distribution

GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.

Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.

Run prepare

npm run prepare

Since the packaged index.js is run from the dist folder.

git add dist

Create a release branch

Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.

Checkin to the v1 release branch

git checkout -b v1
git commit -a -m "v1 release"

git push origin v1

Note: We recommend using the --license option for ncc, which will create a license file for all of the production node modules used in your project.

Your action is now published! 🚀

See the versioning documentation