https://github.com/ohcnetwork/leaderboard-github-plugin
https://github.com/ohcnetwork/leaderboard-github-plugin
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ohcnetwork/leaderboard-github-plugin
- Owner: ohcnetwork
- Created: 2026-01-04T15:08:20.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-01-10T12:40:39.000Z (5 months ago)
- Last Synced: 2026-01-11T03:39:37.576Z (5 months ago)
- Language: TypeScript
- Size: 73.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @ohcnetwork/leaderboard-github-plugin
Leaderboard github plugin
## Configuration
Add the plugin to your `config.yaml`:
```yaml
leaderboard:
plugins:
github:
source: "@ohcnetwork/leaderboard-github-plugin"
config:
# TODO: Add your plugin configuration options here
```
## Usage
1. Build the plugin:
```bash
pnpm build
```
2. Add the plugin to your `config.yaml` (see Configuration above)
3. Run the plugin runner:
```bash
pnpm data:scrape
```
## Development
```bash
# Build the plugin
pnpm build
# Run tests
pnpm test
# Watch mode
pnpm test:watch
```
## Release Process
This package uses [changesets](https://github.com/changesets/changesets) for version management and automated publishing to GitHub's npm registry.
### For Contributors
When making changes that should be included in the next release:
1. Make your code changes
2. Run `pnpm changeset` to create a changeset file
3. Select the type of change (major, minor, or patch)
4. Describe your changes in the prompt
5. Commit the generated changeset file along with your changes
```bash
pnpm changeset
git add .changeset/
git commit -m "feat: your feature description"
```
### For Maintainers
The release process is automated via GitHub Actions:
1. When PRs with changesets are merged to `main`, a "Version Packages" PR is automatically created/updated
2. Review the Version Packages PR to verify:
- Version bumps are correct
- CHANGELOG entries are accurate
3. Merge the Version Packages PR to automatically publish to GitHub's npm registry
### Manual Publishing (if needed)
If you need to publish manually:
```bash
pnpm build
pnpm release
```
Note: You'll need to be authenticated with GitHub's npm registry and have the appropriate permissions.
### Installing from GitHub Packages
To install this package from GitHub's npm registry:
1. Create or update your `.npmrc` file:
```
@ohcnetwork/leaderboard-github-plugin:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
```
2. Install the package:
```bash
npm install @ohcnetwork/leaderboard-github-plugin
```
## License
MIT