Git Product home page Git Product logo

welcome's Introduction

Welcome

MIT License Language PRs Welcome website build Language grade: JavaScript

Welcome new users by creating a comment in the first time issue/PR

first-issue

Usage

Create a .github/workflows/welcome.yml file in the repository you want to install this action, then add the following to it:

name: Welcome
on:
  pull_request:
    types: [opened, closed]
  issues:
    types: [opened]
jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: wow-actions/welcome@v1
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          FIRST_ISSUE: |
            ๐Ÿ‘‹ @{{ author }}
             Thanks for opening your first issue here! Be sure to follow the issue template!

          FIRST_PR: |
            ๐Ÿ‘‹ @{{ author }}
            Thanks for opening this pull request! Please check out our contributing guidelines.

          FIRST_PR_MERGED: |
            ๐ŸŽ‰ @{{ author }}
            Congrats on merging your first pull request! We here at behaviorbot are proud of you!

Inputs

Various inputs are defined to let you configure the action:

Note: Workflow command and parameter names are not case-sensitive.

Name Description Default
GITHUB_TOKEN The GitHub token for authentication N/A
FIRST_ISSUE
or
FIRST_ISSUE_COMMENT
Comment to be posted to on first time issues
FIRST_ISSUE_REACTIONS Reactions to be add to comment on first time issues
FIRST_PR
or
FIRST_PR_COMMENT
Comment to be posted to on PRs from first time contributors in your repository
FIRST_PR_REACTIONS Reactions to be add to comment on PRs from first time contributors in your repository
FIRST_PR_MERGED
or
FIRST_PR_MERGED_COMMENT
Comment to be posted to on pull requests merged by a first time user
FIRST_PR_MERGED_REACTIONS Reactions to be add to comment on pull requests merged by a first time user

Available reactions:

content emoji
+1 ๐Ÿ‘
-1 ๐Ÿ‘Ž
laugh ๐Ÿ˜„
confused ๐Ÿ˜•
heart โค๏ธ
hooray ๐ŸŽ‰
rocket ๐Ÿš€
eyes ๐Ÿ‘€

Other examples

Config for First Issue

name: Welcome
on:
  issues:
    types: [opened]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: wow-actions/welcome@v1
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          FIRST_ISSUE_REACTIONS: '+1, hooray, rocket, heart'
          FIRST_ISSUE_COMMENT: |
            ๐Ÿ‘‹ @{{ author }}
             Thanks for opening your first issue here! Be sure to follow the issue template!

Config for First PR

name: Welcome
on:
  pull_request:
    types: [opened]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: wow-actions/welcome@v1
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          FIRST_PR_REACTIONS: '+1, hooray, rocket, heart'
          FIRST_PR_COMMENT: |
            ๐Ÿ‘‹ @{{ author }}
            Thanks for opening this pull request! Please check out our contributing guidelines.

License

The scripts and documentation in this project are released under the MIT License

welcome's People

Contributors

bubkoo avatar

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.