Compare commits

...

2 commits

Author SHA1 Message Date
8ce5b765e2 docs: update README with badges 2024-09-22 14:22:14 +02:00
955bd0ad10 docs: gitlab 2024-09-22 14:21:42 +02:00
5 changed files with 16 additions and 9 deletions

View file

@ -1,7 +1,16 @@
# releaser-pleaser
`releaser-pleaser` is a tool designed to automate versioning and changelog management for your projects. Building on the concepts of [
`release-please`](https://github.com/googleapis/release-please), it streamlines the release process through GitHub Actions or GitLab CI.
<p align="center">
<code>releaser-pleaser</code> is a tool designed to automate versioning and changelog management for your projects. Building on the concepts of <a href="https://github.com/googleapis/release-please"><code>release-please</code></a>, it streamlines the release process through GitHub Actions or GitLab CI.
</p>
<p align="center">
<a href="https://apricote.github.io/releaser-pleaser" target="_blank"><img src="https://img.shields.io/badge/Documentation-brightgreen?style=flat-square" alt="Badge: Documentation"/></a>
<a href="https://github.com/apricote/releaser-pleaser/releases" target="_blank"><img src="https://img.shields.io/github/v/release/apricote/releaser-pleaser?sort=semver&display_name=release&style=flat-square&color=green" alt="Badge: Stable Release"/></a>
<img src="https://img.shields.io/badge/License-GPL--3.0-green?style=flat-square" alt="Badge: License GPL-3.0"/>
<img src="https://img.shields.io/codecov/c/github/apricote/releaser-pleaser?style=flat-square" alt="Badge: Test Coverage"/>
<img src="https://img.shields.io/github/go-mod/go-version/apricote/releaser-pleaser?style=flat-square" alt="Badge: Go Version"/>
</p>
## Features
@ -15,10 +24,6 @@
`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

View file

@ -5,7 +5,7 @@
# Tutorials
- [Getting started on GitHub](tutorials/github.md)
- [Getting started on GitLab]()
- [Getting started on GitLab](tutorials/gitlab.md)
# Explanation
@ -23,7 +23,7 @@
- [Glossary](reference/glossary.md)
- [Pull Request Options](reference/pr-options.md)
- [GitHub Action](reference/github-action.md)
- [GitLab CI]()
- [GitLab CI/CD Component](reference/gitlab-cicd-component.md)
---

View file

@ -0,0 +1 @@
# GitLab CI/CD Component

View file

@ -1,4 +1,4 @@
# GitHub
# Getting Started on GitHub
In this tutorial we show how to install `releaser-pleaser` in your GitHub project.

1
docs/tutorials/gitlab.md Normal file
View file

@ -0,0 +1 @@
# Getting started on GitLab