This GitHub Action is a Fork of the original GitHub Activity Readme Action by jamesgeorge007.
Its our goal is to improve the original GitHub Action while also providing new features for the users.

The core feature of this GitHub Action is to update your Profile README file, or any Markdown file, with the latest activities you made on GitHub.
Current activities include:

• Issues (Opening, closing and commenting)
• Pull requests (Opening, closing and merging)

Some other activities can't be displayed since they aren't parts of what GitHub's API returns as public events.

You can request a feature if you want to add some other events.

Please read CONTRIBUTING.md file.

If you're a beginner, then here is an article made by @abhijoshi2k that explains how you can create and manage your own Profile README.

The official GitHub documentation about Profile READMEs can be found here.

• To get started, first make sure you add <!--START_SECTION:activity--> somewhere in your README.md file. This is where the list will appear when the action started. See below for more clear description for them.
• Next should you now move on to creating a new Workflow. In this example we create .github/workflows/update-readme.yml
• Now edit the YAML file and add the following content to it:

  name: Update README
  
  on:
    schedule:
      - cron: "*/30 * * * *"
    workflow_dispatch:
  
  jobs:
    build:
      runs-on: ubuntu-latest
      name: Update this repo's README with recent activity
  
      steps:
        - uses: actions/checkout@v2.3.4
        - uses: Readme-Workflows/recent-activity@{version} # Replace {version} with the latest available version on the Repository.
          env:
            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  Notes:
  • The example above would be triggered every 30 minutes. A page explaining the Cron syntax in GitHub Workflows can be found here.
    You can also use Crontab.guru to create the right Cron-format to use.

The Action has different Options that are set through HTML Comments (<!-- text -->) in the markdown file.
Some are required and some are optional. All comments are case-sensitive.

Below is a small example of how the Markdown could look like:

## Recent Activity
This is a list of my most recent Activity on GitHub.
<!--RECENT_ACTIVITY:last_update-->
<!--RECENT_ACTIVITY:start-->

And this would be the result of it:

## Recent Activity
This is a list of my most recent Activity on GitHub.
<!--RECENT_ACTIVITY:last_update-->
Last updated: `01.01.2021 00:00`
<!--RECENT_ACTIVITY:last_update_end-->
<!--RECENT_ACTIVITY:start-->
1. ❗️ Closed issue [#5](https://github.com/Readme-Workflows/recent-activity/issues/5) in [Readme-Workflows/recent-activity](https://github.com/Readme-Workflows/recent-activity/issues/5)
2. 🎉 Merged PR [#6](https://github.com/Readme-Workflows/recent-activity/pull/6) in [Readme-Workflows/recent-activity](https://github.com/Readme-Workflows/recent-activity/pull/6)
3. 🗣 Commented on [#3](https://github.com/Readme-Workflows/recent-activity/discussions/3) in [Readme-Workflows/recent-activity](https://github.com/Readme-Workflows/recent-activity/discussions/3)
4. ❗️ Closed issue [#4](https://github.com/Readme-Workflows/recent-activity/issues/4) in [Readme-Workflows/recent-activity](https://github.com/Readme-Workflows/recent-activity/issues/4)
5. 💪 Opened PR [#6](https://github.com/Readme-Workflows/recent-activity/pull/6) in [Readme-Workflows/recent-activity](https://github.com/Readme-Workflows/recent-activity/pull/6)
<!--RECENT_ACTIVITY:end-->

The Action currently has the following Settings that you can set through the with option.

The following placeholders may be used in the aforementioned settings, if the Supported Placeholders section lists them.

Important Notes:

• Each placeholder with exception of {DATE} will turn into an embedded link pointing to the issue, pull request or discussion of that respective action.
  For example will {ID} turn into [#:id](:url) and {URL} turns into [:url_text](:url).
• Using {ID} or {REPO} in the URL_TEXT setting won't turn them into embedded links. {ID} will still have a # before it.

• The original project was inspired by JasonEtco/activity-box
• Puneet and Abhishek wanted to add a new feature, the original project was no longer maintained, so Puneet created a fork and Abhishek supported him.

A list of examples can be found on the Wiki

Get updates on Recent Activity's development and chat with the Recent Activity maintainers and community members.

Please see the SUPPORT.md file for links.

👏 A big thank you goes to all the supporters of this project!

You prove that the Recent-Activity Action has some value for you!

Thanks to all contributors again!

Visit our Roadmap for planned and upcoming features.

Do you like this project? Why don't show your support by staring it and joining all the other stargazers?