readme_and_act

an action to display recent activity on your profile, python-based as I don't know javascript. Setup is inspired by both recent-activity and github activity readme.

Setup

The action runs on a github repository, and will update a file (specified as 'FILE_NAME', see below) in that repository. The file needs to contain the following markers:

    <!--START_SECTION:raa-->
    <!--END_SECTION:raa-->

The action will replace the content between those markers with the inferred recent activity.

Example

An example of an updated readme:

Action template

This can be used as a template (will run every hour):

name: Activity
on:
  schedule:
    - cron: "0 * * * *"
  workflow_dispatch:
jobs:
  build:
    name: Fetch latest activity
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v6
      - uses: WardDeb/readme_and_act@v0.4.0
        with:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

The only required env variable is the GH_TOKEN, which is needed to commit the changes back to the repository. Other (optional) variables are:

• GH_USERNAME*: github username
• MAX_LINES: maximum number of lines to add in the readme (defaults to 5)
• FILE_NAME: the actual file to be updated (has to contain the markers), defaults to README.md
• REPO_NAME*: the repository to update. Defaults to <GH_USERNAME>/<GH_USERNAME>
• CFG_PATH: Path to a toml configuration file. Defaults to .github/raa.toml

Note that * marked variables are only relevant for testing, and are not relevant when running the action in a github workflow. An example for the CFG_PATH toml file is included in the repository as gh_config.toml.

Testing locally

To test locally, you can use pixi and run:

pixi run test