https://github.com/nickderobertis/github-topic-syncer

Sync Github Topics from a Github Action
https://github.com/nickderobertis/github-topic-syncer

github-actions github-topics sync

Last synced: 8 days ago
JSON representation

Sync Github Topics from a Github Action

• Host: GitHub
• URL: https://github.com/nickderobertis/github-topic-syncer
• Owner: nickderobertis
• License: mit
• Created: 2022-06-25T17:13:26.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-10T22:45:59.000Z (about 2 years ago)
• Last Synced: 2024-04-16T07:25:03.096Z (9 months ago)
• Topics: github-actions, github-topics, sync
• Language: TypeScript
• Size: 821 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Github Topic Syncer

Sync Github Topics from a Github Action.

Whatever topics are provided in the action will replace the topics in the Github repository

when the action is executed.

## Inputs

### `topics`

A space-separated list of topics to sync. Topics can only contain lower-case letters,

numbers, and hyphens.

#### Examples

```yaml

with:

  topics: "web-development python"

```

### `token`

A Github personal access token with the `repo` scope. Typically this is stored

in repository secrets to provide to the action:

#### Examples

```yaml

with:

  token: ${{ secrets.gh_token }}

```

## Examples

Here's an example workflow that syncs the topics of a Github repository whenever

the workflow is updated on the `main` branch.

```yaml

name: Sync Github Topics

on:

  push:

    paths:

      - ".github/workflows/sync-topics.yml"

    branches:

      - main

jobs:

  sync-topics:

    runs-on: ubuntu-latest

    name: Sync Github Topics

    steps:

      - uses: nickderobertis/github-topic-syncer@alpha

        with:

          topics: "topic1 topic-2"

          token: ${{ secrets.gh_token }}

```

## Development Status

This project uses [semantic-release](https://github.com/semantic-release/semantic-release) for versioning.

Any time the major version changes, there may be breaking changes. If it is working well for you, consider

pegging to the current major version, e.g. `nickderobertis/github-topic-syncer@v1`, to avoid breaking changes. Alternatively,

you can always point to the most recent stable release with the `nickderobertis/github-topic-syncer@latest`.

## Developing

Clone the repo and then run `npm install` to set up the pre-commit hooks.

## Author

Created by Nick DeRobertis. MIT License.