Skip to content

A GitHub Action that checks for the existence of a specified list of files.

License

Notifications You must be signed in to change notification settings

chrisreddington/validate-file-exists

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Validate File Exists

GitHub Super-Linter CI Check dist/ CodeQL Coverage Validate Repository Configuration

A GitHub Action that validates whether specified files exist in your repository. This action helps ensure that required files are present before proceeding with your workflow, which is useful for validation steps or pre-deployment checks.

Inputs

Input Description Required
required-files Comma-separated list of files to check for existence Yes

Outputs

Output Description
exists 'true' if all specified files exist

Usage

Basic Example

steps:
  - uses: actions/checkout@v4
  - name: Validate configuration files
    uses: chrisreddington/[email protected]
    with:
      files: README.md

Multiple Files Example

steps:
  - uses: actions/checkout@v4
  - name: Validate configuration files
    uses: chrisreddington/[email protected]
    with:
      files: 'README.md, .github/copilot-instructions.md'

Error Handling

If any of the specified files are missing, the action will:

  1. Fail with a detailed error message listing all missing files
  2. Exit with a non-zero status code, which will cause the workflow to fail

Example error message:

Error: The following files do not exist: config.json, settings.yml

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

A GitHub Action that checks for the existence of a specified list of files.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks