Skip to content

Pause a File

paused_files is the fastest way to tell repolish to leave a file alone. It is designed for temporary situations: a provider shipped a bad update, a migration is in progress, or you just need to ship today and deal with it later.

How to use it

Add the file path to paused_files in your repolish.yaml:

paused_files:
  - .github/workflows/ci.yml

That is the whole change. On the next repolish --check or repolish apply that file will be silently skipped — no diff, no apply, no failure.

What it does (and does not do)

Behaviour Detail
--check File is excluded from comparison. No diff is reported even if the provider would generate different content.
apply File is not written. Your local copy is untouched.
delete_files If a provider requested the file be deleted, the deletion is also skipped.
Everything else All other files continue to be managed normally.

Pausing a file does not remove the provider's template. When you unpause the file, repolish will resume comparing and applying it on the next run.

Multiple files

paused_files:
  - .github/workflows/ci.yml
  - pyproject.toml # provider migration pending
  - docs/CONTRIBUTING.md

Leave a comment

paused_files entries are easy to forget. Leave a short note explaining why the file is paused and link to a ticket or PR if there is one:

paused_files:
  # provider#42 — ruff config format change not yet merged
  - ruff.toml

When to unpause

Remove the entry once the underlying provider issue is resolved and you have run repolish apply to pull in the updated file. Leaving entries in paused_files indefinitely defeats the purpose of using repolish to keep files consistent.

Suppress vs pause

paused_files is temporary. If you want to permanently exclude a file from all providers, use template_overrides with a null value instead.