apricote/releaser-pleaser
1
0
Fork 0
mirror of https://github.com/apricote/releaser-pleaser.git synced 2026-01-13 21:21:03 +00:00
Code Issues Projects Releases Packages Wiki Activity
releaser-pleaser/docs/reference/glossary.md
Julian Tölle f1aa1a2ef4
refactor: let updaters define the files they want to run on (#233) 
This change reverses the responsibility for which files the updaters are
run on. Now each updater can specify the list of files and wether the
files should be created when they do not exist yet. This simplifies the
handling of each update in releaserpleaser.go, as we can just iterate
over all updaters and call it for each file of that updater.

Also update the flags to allow users to easily define which updaters
should run.
2025-08-23 22:14:34 +02:00

2.6 KiB
Raw Blame History

Glossary

Changelog

The Changelog is a file in the repository ( CHANGELOG.md) that contains the Release Notes for every release of that repository. Usually, new releases are added at the top of the file.

Conventional Commits

Conventional Commits is a specification for commit messages. It is the only supported commit message schema in releaser-pleaser. Follow the link to learn more.

Forge

A **forge ** is a web-based collaborative software platform for both developing and sharing computer applications.1

Right now only GitHub is supported. We plan to support **GitLab ** in the future (#4). For other forges like Forgejo or Gitea, please open an issue and submit a pull request.

Markdown

Markdown is a lightweight markup language used on many forges as the preferred way to format text.

In releaser-pleaser Markdown is used for most texts.

Pre-release

Pre-releases are a concept of SemVer. They follow the normal versioning schema but use a suffix out of -alpha.X, -beta.X and -rc.X.

Pre-releases are not considered "stable" and are usually not recommended for most users.

Learn more in the Pre-releases guide.

Release Pull Request

A Release Pull Request is opened by releaser-pleaser whenever it finds releasable commits in your project. It proposes a new version number and the Changelog. Once it is merged, releaser-pleaser creates a matching release.

Learn more in the Release Pull Request explanation.

Release Notes

Release Notes describe the changes made to the repository since the last release. They are made available in the Changelog, in Git Tags and through the forge-native Releases.

Learn more in the Release Notes customization guide.

Semantic Versioning (SemVer)

Semantic Versioning is a specification for version numbers. It is the only supported versioning schema in releaser-pleaser. Follow the link to learn more.

Updater

Updaters can update or create files that will be included in Release Pull Request. Examples of Updaters are changelog for CHANGELOG.md, generic that can update arbitrary files and packagejson that knows how to update Node.JS package.json files.