https://github.com/eddiehubcommunity/gh-action-community

GitHub Action for the Community, from welcoming first timers to badges
https://github.com/eddiehubcommunity/gh-action-community

action actions github

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/eddiehubcommunity/gh-action-community
• Owner: EddieHubCommunity
• License: mit
• Created: 2020-09-05T05:11:14.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-10T23:23:57.000Z (8 months ago)
• Last Synced: 2024-06-19T17:49:52.123Z (6 months ago)
• Topics: action, actions, github
• Language: JavaScript
• Homepage:
• Size: 5.98 MB
• Stars: 35
• Watchers: 5
• Forks: 20
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# 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`)

```yaml

  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: '
It''s great having you contribute to this project
 Feel free to raise an Issue! Welcome to the community :nerd_face:'

          pr-message: '
It''s great having you contribute to this project
 Feel free to create a Pull Request! 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)

```yaml

  statistics:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@main

      - uses: EddieHubCommunity/gh-action-community/src/statistics@main

        if: ${{  }}

        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](https://github.com/EddieHubCommunity/gh-action-community/blob/main/CODE_OF_CONDUCT.md).