https://github.com/wow-actions/purge-readme
GitHub Action to clear the cache of images embeded in GitHub README or markdown files
https://github.com/wow-actions/purge-readme
cache github-actions purge readme
Last synced: 3 months ago
JSON representation
GitHub Action to clear the cache of images embeded in GitHub README or markdown files
- Host: GitHub
- URL: https://github.com/wow-actions/purge-readme
- Owner: wow-actions
- License: mit
- Created: 2022-12-16T04:41:36.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-22T23:19:24.000Z (over 1 year ago)
- Last Synced: 2024-03-14T19:31:05.044Z (about 1 year ago)
- Topics: cache, github-actions, purge, readme
- Language: TypeScript
- Homepage:
- Size: 451 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Purge README
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:
```yml
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](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#about-workflow-commands).
| 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` |
```yml
- 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](LICENSE)