apricote/releaser-pleaser
1
0
Fork 0
mirror of https://github.com/apricote/releaser-pleaser.git synced 2026-01-13 13:21:00 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
68 commits 6 branches 17 tags 3 MiB
Find a file
Julian Tölle 2effe5e72d
feat: edit commit message after merging through PR (#43) 
Closes #5
2024-09-06 23:17:06 +02:00
.github/workflows docs: add all current features (#34) 2024-08-25 22:13:56 +02:00
cmd/rp refactor: move things to packages (#39) 2024-08-31 15:23:21 +02:00
docs feat: edit commit message after merging through PR (#43) 2024-09-06 23:17:06 +02:00
internal feat: edit commit message after merging through PR (#43) 2024-09-06 23:17:06 +02:00
.gitattributes docs: add all current features (#34) 2024-08-25 22:13:56 +02:00
.golangci.yaml chore: enable some more linters (#16) 2024-08-23 22:35:06 +02:00
.ko.yaml ci: setup release workflow 2024-08-05 19:41:52 +02:00
action.yml chore(main): release v0.2.0 (#24) 2024-08-25 23:01:48 +02:00
CHANGELOG.md chore(main): release v0.2.0 (#24) 2024-08-25 23:01:48 +02:00
go.mod refactor: replace markdown renderer (#40) 2024-08-31 16:49:07 +02:00
go.sum refactor: replace markdown renderer (#40) 2024-08-31 16:49:07 +02:00
LICENSE chore: working releasable commits 2024-07-12 14:51:24 +02:00
prbody.go feat: edit commit message after merging through PR (#43) 2024-09-06 23:17:06 +02:00
prbody_test.go feat: edit commit message after merging through PR (#43) 2024-09-06 23:17:06 +02:00
README.md docs: add proper readme 2024-08-03 01:41:05 +02:00
releaserpleaser.go feat: edit commit message after merging through PR (#43) 2024-09-06 23:17:06 +02:00

README.md

releaser-pleaser

releaser-pleaser is a tool designed to automate versioning and changelog management for your projects. Building on the concepts of release-please, it streamlines the release process through GitHub Actions or GitLab CI.

Features

  • Automated Pull Requests: Opens a PR when releasable changes are detected.
  • Smart Versioning: Suggests new versions based on conventional commits and semantic versioning.
  • Version Reference Updates: Automatically updates committed version references in the PR.
  • Changelog Generation: Creates new changelog entries based on commits.
  • Automated Releases: Upon PR merge, creates tags and GitHub/GitLab Releases with appropriate messages.
  • Version Overrides: Allows manual override of the suggested version.
  • Prerelease Support: Offers options to create alpha, beta, or release candidate versions.

releaser-pleaser simplifies release management, allowing maintainers to focus on development while ensuring consistent and well-documented releases.

Status

This project is still under active development. You can not reasonably use it right now and not all features advertised above work. Keep your eyes open for any releases.

Relation to release-please

After using release-please for 1.5 years, I've found it to be the best tool for low-effort releases currently available. While I appreciate many of its features, I identified several additional capabilities that would significantly enhance my workflow. Although it might be possible to incorporate these features into release-please, I decided to channel my efforts into creating a new tool that specifically addresses my needs.

Key differences in releaser-pleaser include:

  • Support for multiple forges (both GitHub and GitLab)
  • Better support for pre-releases

One notable limitation of release-please is its deep integration with the GitHub API, making the addition of support for other platforms (like GitLab) a substantial undertaking. releaser-pleaser aims to overcome this limitation by design, offering a more versatile solution for automated release management across different platforms and project requirements.

License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0).