https://github.com/numtide/clean-git-action

Leave no build artifacts behind
https://github.com/numtide/clean-git-action

clean git github-action github-actions

Last synced: 2 days ago
JSON representation

Leave no build artifacts behind

• Host: GitHub
• URL: https://github.com/numtide/clean-git-action
• Owner: numtide
• Created: 2021-04-19T14:40:17.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-17T07:10:44.000Z (5 months ago)
• Last Synced: 2024-10-14T14:03:14.619Z (25 days ago)
• Topics: clean, git, github-action, github-actions
• Language: Shell
• Homepage:
• Size: 53.7 KB
• Stars: 11
• Watchers: 7
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Clean Git Status Action - leave no build artifacts behind.

A very small GitHub Action that checks that the `git status` is clean at the

end of a build.

Build process tends to drift and leave files behind that are either changed or

untracked. Generally when that happens, it can be either of those two things:

1. A new build artifact appeared, that should be added to `.gitignore`

2. Some `.lock` file or other generated file was updated and needs to be

   committed to the repo.

By adding this simple action to your project, you make sure that these issues

are surfaced early.

## Usage

Add the following step to your action YAML

```yaml:

- uses: numtide/clean-git-action@v2

```

Here is how it looks like on success:

![success](./success.png)

Here is how it looks like on failure:

![failure](./failure.png)

That's it!

## License

MIT - 2021 Numtide