Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/olivernybroe/action-conflict-finder

A Github action for finding merge conflicts
https://github.com/olivernybroe/action-conflict-finder

github-action github-actions github-workflow hacktoberfest merge-conflicts

Last synced: 15 days ago
JSON representation

A Github action for finding merge conflicts

Awesome Lists containing this project

README

        

# Merge Conflict Finder

This action finds any merge conflicts in your repository.

Sometimes we accidentally resolve merge conflicts without actually resolving it,
this action simply finds if we have any instances of files with merge conflicts we
didn't resolve and reports them.

## How to use it?
This is a GitHub action, so it has to be added to a GitHub workflow.
A simple example of running this action on all pushes to the repository would be
to add a `main.yml` file under `.github/workflows` with the following content
```yaml
on: [push]

jobs:
merge_conflict_job:
runs-on: ubuntu-latest
name: Find merge conflicts
steps:
# Checkout the source code so there are some files to look at.
- uses: actions/checkout@v2
# Run the actual merge conflict finder
- name: Merge Conflict finder
uses: olivernybroe/[email protected]
```

On each push, it will now run the merge conflict finder

### Excludes
You can add custom excludes to the search through the following inputs:

#### `exclude_dir`
A comma separate list of directories to ignore. The .git folder is always ignored

#### `excludes`
A comma separated list of files to ignore. Supports wildcard matching.

A workflow with the inputs could look like:

```yaml
on: [push]

jobs:
merge_conflict_job:
runs-on: ubuntu-latest
name: Find merge conflicts
steps:
# Checkout the source code so we have some files to look at.
- uses: actions/checkout@v2
# Run the actual merge conflict finder
- name: Merge Conflict finder
uses: olivernybroe/[email protected]
with:
exclude_dir: "path/to/ignore,path/to/ignore2"
excludes: "ignore.me,*.zip"
```