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.

gh-action-community's Issues

test

save user stats to Firestore with GitHub Action

test

Pull Requests fail because Forks do not have access to the Repo's "Secrets"

• How can we get round this?
• Alternative options
  • Save stats in a json file instead of the DB - but will make having badges on an API more challenging (could then have another action to update the DB once the PR is merged to develop 🤷‍♂️
  • Try not to run the Action for forks PRs - not sure how that will effect stats

test

test issue

My first issue in gh-action-community 🎉

My first issue in gh-action-community 🎉

test

Test Issue

Hello World!

test 8

test7

Fixing welcome action

Hi

This issue to fix the following issues:

• duplicate this section (without the required and default) for the footer variable
• grab the footer variable here
• remove the hardcode string here

I will open a PR to fix it.

Thanks

test 11

Append default footer to welcome message

Twitter account to tweet when issues with label "good first issue" is created

On completion of successful PR tweet the feeds with a snapshot of the user achievements.

Automating invite to organisation for new members through bot

test

test4

Hello test

just a test to say hello

Comment message name

There should be github-actions name or the person's name when a person is invited to an organization

Here you can find a demo message

test 12

GitHub Organization link broken

The link for GitHub organization is broken in the welcoming message "It's great having you contribute to this project"

So, it needs some updates in the GitHub actions file.

Separate GitHub Action into sub Actions

I demand unlimited power on Discord

I should be in charge. Thank you.

test 10

test 1b

How to test?

I don't know how to test this, It would have been nice to have some documented steps to follow, at least to try out a few of the features

Create a release

test5

test3

Add GitLeaks Github Action

Add GitLeaks Github Action
https://github.com/zricethezav/gitleaks/wiki/Scanning

Is this a bit too spammy? (It's great having you contribute to this project)

Opening a new issue as a seasoned EddieHub contributor/mod/whatever... it seems quite counterproductive to always respond with a thanks - especially as I imagine this creates more notifications but I could be totally wrong here!

Maybe it can fire off once for a new member who has contributed to an issue or even created their first issue then never fire off again?

test 13

test

first timers welcome message

Create labels from inputs

Have default labels, this can be used to sync up between repos.

test 9

Add stale action

test

test

test issue 2

Creating a test issue

😄

Check if Firebase key exists before running statistics action

It will make testing community.yml easier

The welcome message didn't render correctly

Rendered message:

Try using html instead of markdown.

For example:

Congratulations 🎉

This is your first Issue! Welcome to the community 🤓

<h1>Congratulations :tada:</h1>This is your first <strong>Issue</strong>! Welcome to the community :nerd_face:

test 2

test

test issue

Make the Documentation More Comprehensive?

@eddiejaoude Maybe we could make the documentation a little bit more encompassing?

test6

I just trademarked "Eddie Jaoude"

Pay up or I will be forced to sue.