Skip to content

github-account-info-2-readme

Actions
GitHub Action that retrieves user information, such as public data and repositories, and inserts it into a README file
v0.0.5
Latest
Star (0)

Tags

 (1)

GitHub Account Info to README

Description

This GitHub Action retrieves information about a specified GitHub account, such as public data, repositories, and other relevant details, and inserts this information into a specified README file.

Example Workflows

Example Workflow with Personal GitHub Token

name: Update README with GitHub Account Info

on:
  push:
    branches:
      - main

jobs:
  update-readme:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Insert GitHub Account Info into README
        uses: kotorkovsciy/[email protected]
        with:
          GH_TOKEN: ${{ secrets.PERSONAL_GITHUB_TOKEN }}  # Your personal GitHub token
          github_username: kotorkovsciy
          target_file: README.md

Example Workflow with Repository Token

name: Update README with GitHub Account Info

on:
  push:
    branches:
      - main

jobs:
  update-readme:
    runs-on: ubuntu-latest
    permissions:
      contents: write  # Grant permission to write to the repository contents
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Insert GitHub Account Info into README
        uses: kotorkovsciy/[email protected]
        with:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Repository token
          github_username: kotorkovsciy
          target_file: README.md

Tags in readme

<!--START_LAST_REPO-->
Latest Project: Your last repository will appear here.
<!--END_LAST_REPO-->


<!--START_TABLE_REPOS-->
| Name | Homepage | Stars | Last Commit |
|------|----------|-------|-------------|
| Repo1 | https://github.com/user/repo1 | 100 | ![Last Commit](https://img.shields.io/github/last-commit/user/repo1?style=flat&label=last) |
| Repo2 | https://github.com/user/repo2 | 150 | ![Last Commit](https://img.shields.io/github/last-commit/user/repo2?style=flat&label=last) |
<!--END_TABLE_REPOS-->

github-account-info-2-readme is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

GitHub Action that retrieves user information, such as public data and repositories, and inserts it into a README file
v0.0.5
Latest

Tags

 (1)

github-account-info-2-readme is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.