Introduction

Introduction

Tegami (手紙) is a tool to manage changelogs, versioning, and publishing.

It unifies the release pipeline across different programming languages and package managers.

Why Tegami?

Previously, to release packages, you have to manually update package versions, workspace dependency ranges, write changelogs, then create a GitHub releases or post to other channels.

With CI, you might roll your own script to automate all processes. Tegami is built on this idea: a tool to automate all above into a Node.js script.

The key ideas of Tegami:

• It is a script: you create a Node.js script with Tegami, and use it to bump versions & publish packages, rather than using a CLI tool or GitHub bot. This keeps the setup simple and familiar if you started from a custom workflow.
• Plugin first: Most funtionalities are powered by plugins, this makes Tegami flexible enough to fit in any workflows.

Who is using it?

Tegami is used by Takumi, Fumadocs, Fumapress, and many other projects.

Compared to Alternatives

Tegami was mainly created as a better alternative for Changesets, with solutions to some unsolved issues & problems.

• Cross-registry version management: support across npm, crates.io, PyPI, RubyGems, Maven Central, NuGet, Hex, and other registries via plugins.
• Programmatic API: allows robust use cases of the tool, such as using the willPublish() hook on plugins to build packages only when published.

Release cycle

The workflow has three phases:

Next steps