README.md

WolfStar Project · GitHub

Shared GitHub metadata, reusable workflows, and community templates for the WolfStar Project organization.

Official Site · Dashboard · WolfStar Invite Link · Support Server · Feedback

Share WolfStar Project

^{Centralized GitHub metadata and CI workflows for the WolfStar ecosystem. Built for maintainers and contributors.}

Table of contents

Table of Contents

• ✨ Features
• 📦 Organization Metadata
• 🔄 Reusable Workflows
• ⌨️ Local Development
• 💻 Online Development
• 🤝 Contributing
• ❤️ Sponsor

👋🏻 Welcome to WolfStar Project · GitHub

This repository is the central hub for GitHub organization metadata across the WolfStar Project ecosystem. It provides issue templates, community guidelines, label definitions, problem matchers, and reusable GitHub Actions workflows that other repositories in the organization can consume.

✨ Features

• Issue Templates: Structured YAML templates for bug reports and feature requests, with a configurable issue chooser.
• Community Guidelines: Code of conduct, contributing guide, security policy, and privacy policy shared across all organization repositories.
• Label Sync: Centralized label definitions in .github/labels.yml for consistent issue and pull request triage.
• Reusable Workflows: Pre-built GitHub Actions workflows for Node.js/pnpm setup, label synchronization, and multi-platform Docker image publishing.
• Problem Matchers: GitHub Actions problem matchers for ESLint and TypeScript compiler output.
• Renovate Configuration: Shared Renovate bot settings for automated dependency updates.

📦 Organization Metadata

The following files are maintained in this repository and referenced by other WolfStar Project repositories:

File	Description
.github/ISSUE_TEMPLATE/	Bug report and feature request templates
.github/CODE_OF_CONDUCT.md	Community code of conduct
.github/CONTRIBUTING.md	Contribution guidelines
.github/SECURITY.md	Security vulnerability reporting policy
.github/PRIVACY_POLICY.md	Privacy policy
.github/labels.yml	Organization-wide label definitions
.github/problemMatchers/	ESLint and TypeScript problem matchers
.github/renovate.json	Shared Renovate bot configuration
.github/CODEOWNERS	Default code ownership rules

🔄 Reusable Workflows

This repository provides reusable GitHub Actions workflows that can be called from any repository in the organization via workflow_call.

Setup pnpm & Node

The reusable-setup.yml workflow handles checkout, pnpm and Node.js setup, and optional dependency installation. It supports configurable Node.js versions, pnpm versions, operating systems, and frozen lockfile installs.

jobs:
  build:
    uses: wolfstar-project/.github/.github/workflows/reusable-setup.yml@main
    with:
      node-version: 24
      install-dependencies: true

Label Sync

The reusable-labelsync.yml workflow synchronizes GitHub labels from .github/labels.yml to a target repository. It supports merging with repository-specific label overrides.

jobs:
  labels:
    uses: wolfstar-project/.github/.github/workflows/reusable-labelsync.yml@main
    with:
      merge-labels: false

Publish Docker Image

The reusable-publish-image.yml workflow builds and publishes multi-platform Docker images to GitHub Container Registry (GHCR). It supports configurable platforms, tags, build context, and Dockerfile paths.

jobs:
  publish:
    uses: wolfstar-project/.github/.github/workflows/reusable-publish-image.yml@main
    with:
      registryImage: wolfstar-project/wolfstar
      tag: latest

⌨️ Local Development

Prerequisites

• Bun or Node.js (v24+)
• mise (optional, for tool version management)

Available Scripts

• bun run format — Format files with Oxfmt.

Refer to CONTRIBUTING.md for detailed setup instructions across WolfStar Project repositories.

💻 Online Development

Click any of the buttons below to start a new development environment to demo or contribute to the codebase without having to install anything on your machine:

🤝 Contributing

Thank you to all the people who already contributed to WolfStar Project! Please make sure to read the Contributing Guide before making a pull request.

❤️ Sponsor

If you like WolfStar and want to support the project, consider making a donation. Every contribution helps to maintain and improve the bot.

Thank you for your support!

---

---

📝 License

Copyright © 2024 WolfStar Project.
This project is MIT licensed.