From c1db1b20e0fc2b44b7041bd03a579de458f3ba82 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20T=C3=B6lle?= Date: Sun, 15 Sep 2024 19:21:49 +0200 Subject: [PATCH 1/3] docs: placeholder for extra-files guide --- docs/SUMMARY.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 1125209..978f0d5 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -16,6 +16,7 @@ - [Customizing Release Notes](guides/release-notes.md) - [Pre-releases](guides/pre-releases.md) - [Workflow Permissions on GitHub](guides/github-workflow-permissions.md) +- [Updating arbitrary files]() # Reference From a7811991eef66bbcf9cfdeee049ee9152040d129 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20T=C3=B6lle?= Date: Sun, 15 Sep 2024 21:01:49 +0200 Subject: [PATCH 2/3] docs: gitlab --- docs/SUMMARY.md | 4 ++-- docs/reference/gitlab-cicd-component.md | 1 + docs/tutorials/github.md | 2 +- docs/tutorials/gitlab.md | 1 + 4 files changed, 5 insertions(+), 3 deletions(-) create mode 100644 docs/reference/gitlab-cicd-component.md create mode 100644 docs/tutorials/gitlab.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 978f0d5..146f9f7 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -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) --- diff --git a/docs/reference/gitlab-cicd-component.md b/docs/reference/gitlab-cicd-component.md new file mode 100644 index 0000000..7d8bf16 --- /dev/null +++ b/docs/reference/gitlab-cicd-component.md @@ -0,0 +1 @@ +# GitLab CI/CD Component diff --git a/docs/tutorials/github.md b/docs/tutorials/github.md index 83f797c..031e594 100644 --- a/docs/tutorials/github.md +++ b/docs/tutorials/github.md @@ -1,4 +1,4 @@ -# GitHub +# Getting Started on GitHub In this tutorial we show how to install `releaser-pleaser` in your GitHub project. diff --git a/docs/tutorials/gitlab.md b/docs/tutorials/gitlab.md new file mode 100644 index 0000000..9dc1491 --- /dev/null +++ b/docs/tutorials/gitlab.md @@ -0,0 +1 @@ +# Getting started on GitLab From b2e2dd9a1777d0599cdfca8a86a4cb32fa470731 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20T=C3=B6lle?= Date: Sun, 15 Sep 2024 21:27:41 +0200 Subject: [PATCH 3/3] docs: update README with badges --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6c282dd..fa68b1e 100644 --- a/README.md +++ b/README.md @@ -1,6 +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. +

+ 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. +

+ +

+ Badge: Documentation + Badge: Stable Release + Badge: License GPL-3.0 + Badge: Test Coverage + Badge: Go Version +

## Features @@ -14,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 `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.