Coder Social home page Coder Social logo

check-for-conflicts-action's Introduction

Check for Conflicts Action

This action check for conflicts in your PR and prints "Hello World" or "Hello" + the name of a person to greet to the log.

Sometimes we make PRs and if they are left for some time, conflicts may arise.
This action simply finds if we have any instances of files with merge conflicts we didn't resolve and reports them.

Inputs

  • who-to-greet
    Required
    The name of the person to greet.
    Default: "World".

Outputs

  • time
    The time we greeted you and conflicts if any.

Example-Usage

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 add a main.yml file under .github/workflows with the following content

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: Check for Conflicts Action
        uses: actions/[email protected]
        with:
          who-to-greet: 'Noviicee'

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

Excludes

You can also 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:

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: Check for Conflicts Action
        uses: actions/[email protected]
        with:
          who-to-greet: 'Noviicee'
          exclude_dir: "path/to/ignore,path/to/ignore2"
          excludes: "ignore.me,*.zip"

Make sure to make the checkconflicts.sh file executable by running the following command on your system.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.