TUWA Workflows & Community Standards

About This Repository

This repository is the single source of truth for CI/CD automation and community standards across the entire TUWA ecosystem. Its purpose is to centralize logic, enforce consistency, and make it easy to manage and update development processes for all projects.

By using the reusable components from this repository, we follow the DRY (Don't Repeat Yourself) principle, saving time and reducing errors.

---

What's Inside?

• .github/workflows/: A collection of reusable GitHub Actions workflows for common tasks.
• CONTRIBUTING.md: Centralized community guidelines.
• preview/: Shared assets like logos and diagrams that can be referenced from other repositories.

---

Available Workflows

Here is a list of the reusable workflows available in this repository:

Workflow File	Description
reusable-alpha-release.yml	Publishes an alpha version to NPM. Triggered by pushes to dev, fix, and feat branches.
reusable-stable-publish.yml	Publishes a stable version to NPM after a release is created by release-please.

---

How to Use

Using Reusable Workflows

To use a workflow from this repository, you call it from a workflow file in your own project using the uses keyword.

Example: To implement the alpha release process, create a .github/workflows/alpha-release.yml file in your project with the following content:

name: Alpha Release

on:
  push:
    branches:
      - 'dev/**'
      - 'fix/**'
      - 'feat/**'

jobs:
  call-alpha-release:
    # This line calls the reusable workflow
    uses: TuwaIO/workflows/.github/workflows/reusable-alpha-release.yml@main

    # This line is crucial for passing secrets like GITHUB_TOKEN and NPM_TOKEN
    secrets: inherit

Note on Versioning: The @main at the end of the uses path means you will always use the latest version from the main branch. For production stability, it is recommended to pin to a specific version tag, like @v1.0.0, once you create releases in this repository.

Linking to Community Files

Instead of duplicating CONTRIBUTING.md in every repository, you can create a small file in your project that links here.

Example CONTRIBUTING.md in your project:

# Contribution Guidelines

This project follows the central TUWA contribution guidelines. Please read them here:
[TUWA Contribution Guidelines](https://github.com/TuwaIO/workflows/blob/main/CONTRIBUTING.md)