Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update plugin documentation #190

Merged
merged 2 commits into from
Sep 30, 2024
Merged

Update plugin documentation #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82df439
Update docs.md
anbraten Sep 30, 2024
b25870c
Update README.md
anbraten Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ready release go :rocket:

This plugin can be executed on every push to your release branch (e.g. main) and will create a new release pull-request with all of your custom adjustments like an updated changelog as preparation for the next release. After you have merged the "release"-pull-request with all your desired changes, a new release / tag will be created for you.
This plugin can be executed on every push to your release branch (e.g. default branch) and will create a new release pull-request with an updated changelog as preparation for the next release. After merging the "release"-pull-request, a new release / tag will be created for you.

## Usage

Expand Down
7 changes: 4 additions & 3 deletions docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Release Helper
name: Ready release go 🚀
description: Plugin for semi-automated releases.
author: Woodpecker Authors
tags: [git, release]
Expand All @@ -10,8 +10,9 @@ url: https://github.com/woodpecker-ci/plugin-ready-release-go

# Introduction

This plugin aims to help with git-based releases.
It should be run on every commit of the default branch to execute it's necessary actions.
This plugin can be executed on every push to your release branch (e.g. default branch) and will create a new release pull-request with an updated changelog
as preparation for the next release.
After merging the "release"-pull-request, a new release / tag will be created for you.

A Woodpecker workflow file could look like this:

Expand Down