Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to customize messages #52

Open
Andre601 opened this issue Apr 23, 2021 · 1 comment
Open

Add option to customize messages #52

Andre601 opened this issue Apr 23, 2021 · 1 comment
Labels
feature New feature

Comments

@Andre601
Copy link

Andre601 commented Apr 23, 2021

It would be a great addition, if there was a way to customize the messages displayed and used within the readme file.

Imagine the following example settings:

name: Update README

on:
  schedule:
    - cron: '0 0 */1 * *' # Runs every day at 00:00
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    name: Update Profile README

    steps:
      - uses: actions/checkout@v2
      - uses: jamesgeorge007/github-activity-readme@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          COMMIT_MSG: "Update latest activity in README"

          COMMENT: "Commented on [{REPO}{ID}]({URL})"

          # PR Actions
          OPEN_PR: "Opened PR [{REPO}{ID}]({URL})"
          MERGE: "Merged Pull request [{REPO}{ID}]({URL})"
          CLOSE_PR: "Denied Pull request [{REPO}{ID}]({URL})"

          # Issue Actions
          OPEN_ISSUE: "Opened Issue [{REPO}{ID}]({URL})"
          CLOSE_ISSUE: "Closed Issue [{REPO}{ID}]({URL})"

{REPO} and {ID} are example placeholders and other syntaxes for them could be used. They essentially are replaced with the :user/:repository and issue/PR id (#:id) respectively.

The above example setup could result in the following 5 entries being displayed:

  1. Opened Issue jamesgeorge007/github-activity-readme#52
  2. Merged Pull request jamesgeorge007/github-activity-readme#41
  3. Commented on jamesgeorge007/github-activity-readme#52
  4. Denied Pull request jamesgeorge007/github-activity-readme#34
  5. Commented on jamesgeorge007/github-activity-readme#52

The above examples are taken from Pull requests and issues in this repository to give a better example of my point.
I really hope this can be implemented as it would allow a lot more customization of the displayed info and could allow to blend it into the style of your Readme a bit more.

@tuunit
Copy link
Collaborator

tuunit commented May 31, 2023

I'll considered it. Thank you for the detailed description.

@tuunit tuunit added the feature New feature label Aug 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature
Projects
None yet
Development

No branches or pull requests

2 participants