eddiehubcommunity / gh-action-community

GitHub Action for the Community, from welcoming first timers to badges

GitHub Action Community

GitHub Action for the Community - from welcoming first timers to logging your activity for badges!

GitHub Action Features 💡

These GitHub Actions will:

• reply to all new Issues and Pull Requests
• log statistics of user activity to Firestore DB (Firebase)

Quickstart

You can use 1 or all of these GitHub Actions.

To create a GitHub Action

1. In the folder .github/workflows/
2. Create a file welcome.yaml (or another name you prefer)
3. Add the Action config

Welcoming message

This GitHub Action will reply to all new Issues and Pull Requests with a custom message

Example usage (you can change the replies for issue-message and pr-message)

  welcome:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@main
      - uses: EddieHubCommunity/gh-action-community/src/welcome@main
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          issue-message: '<h1>It''s great having you contribute to this project</h1> Feel free to raise an <strong>Issue</strong>! Welcome to the community :nerd_face:'
          pr-message: '<h1>It''s great having you contribute to this project</h1> Feel free to create a <strong>Pull Request</strong>! Welcome to the community :nerd_face:'

Options

footer is an optional parameter, which can be used to append the issue-message and pr-message

Store community activity

This GitHub Action will log statistics of user activity to Firestore DB (Firebase)

  statistics:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@main
      - uses: EddieHubCommunity/gh-action-community/src/statistics@main
        if: ${{ <expression> }}
        with:
          api-key: ${{ secrets.API_TOKEN }}
          api-url: ${{ secrets.API_URI }}

Here is a complete example https://github.com/EddieHubCommunity/LinkFree/blob/main/.github/workflows/community.yml

Our Pledge

We take participation in our community as a harassment-free experience for everyone and we pledge to act in ways to contribute to an open, welcoming, diverse and inclusive community.

If you have experienced or been made aware of unacceptable behaviour, please remember that you can report this. Read our Code of Conduct.