Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.04 KB

README.md

File metadata and controls

35 lines (23 loc) · 1.04 KB

Remove File

Removes a given file or folder in a cross-platform way.

Created by Jesse Talavera-Greenberg.

Installation

Enable local and third-party actions for your repository, then just follow the instructions in Usage.

Usage

Use this action in any particular step like so:

- name: Remove File
  uses: JesseTG/rm@v1.0.3
  with:
    path: /path/to/something/you/want/to/delete

Other useful facts:

  • Uses io.rmRF, so it will remove files and directories recursively.
  • Succeeds even if the requested path doesn't exist.
  • Works on all environments.
  • Only supports one path at a time; for multiple paths, use this action multiple times.
  • Supports relative and absolute paths, but does not support globs or wildcards.
  • Does not protect important system paths. Be careful if you're using a self-hosted runner.
  • Can be used to remove files from your repository within a workflow, but you will have to commit the changes yourself.

License

MIT.