Skip to content
file-text

GitHub Action

Purge README

v1.0.0 Latest version

Purge README

file-text

Purge README

Clear the cache of images embeded in GitHub README or markdown files

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Purge README

uses: wow-actions/[email protected]

Learn more about this action in wow-actions/purge-readme

Choose a version

Purge README

build MIT License Language PRs Welcome website

Clear the cache of images embeded in GitHub README or markdown files

Usage

Create a .github/workflows/purge-readme.yml file in the repository you want to install this action:

name: Purge README
on: push
jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: wow-actions/purge-readme@v1

Inputs

Various inputs are defined to let you configure the action:

Note: Workflow command and parameter names are not case-sensitive.

Name Description Default
repo The repo with [owner]/[repo] format. The repo of the action running on
branch The branch to purge. The branch of the action running on
paths The markdown file paths to purge. README.md
- uses: wow-actions/purge-readme@v1
  with:
    repo: wow-actions/purge-readme
    branch: master
    paths: |
      README.md
      images.md

License

The application code and associated documentation is under the MIT License