github-action-repo-sync

GitHub Action to sync repo metadata from package.json to GitHub.

Overview

This action detects metadata from common project configuration files and automatically updates the repository metadata shown in the sidebar on the repository's homepage on GitHub.

It supports setting the description, topic keywords, and homepage URL from package.json, pyproject.toml, or a language-agnostic metadata.json or metadata.yml file.

It's a re-implementation of kbrashears5/github-action-repo-sync.

Getting started

Add the following to your project's .github/workflows directory:

name: Set GitHub Metadata
on:
  push:
    branches: [main]
  workflow_dispatch: {}

jobs:
  build:
    name: Set GitHub Metadata
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Sync Package info to GitHub
        uses: kitschpatrol/github-action-repo-sync@v3
        with:
          TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}

The next time you commit to main, the action will run and update the repository metadata (if possible).

Maintainers

@kitschpatrol

Acknowledgments

Thanks to Kevin Brashears for the original shell docker / implementation.

License

MIT © Eric Mika