Skip to content

Commit

Permalink
Add note to release PR about this plugin (#36)
Browse files Browse the repository at this point in the history
  • Loading branch information
anbraten authored Oct 31, 2023
1 parent dbdac73 commit 20e9304
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
9 changes: 8 additions & 1 deletion src/cmd/prepare.ts
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,14 @@ export async function prepare({

const releaseDescription = config.user.getReleaseDescription
? await config.user.getReleaseDescription(hookCtx)
: getChangeLogSection(nextVersion, config, changes, forge, false);
: `This PR was opened by the ` +
`[ready-release-go](https://github.com/woodpecker-ci/plugin-ready-release-go) plugin.` +
`When you're ready to do a release, you can merge this and a release and tag with ` +
`version \`${nextVersion}\` will be created automatically.` +
`If you're not ready to do a release yet, that's fine, ` +
`whenever you add more changes to \`${releaseBranch}\`` +
`this PR will be updated.` +
getChangeLogSection(nextVersion, config, changes, forge, false);

console.log("# Creating release pull-request");
const pullRequestLink = await forge.createOrUpdatePullRequest({
Expand Down
2 changes: 1 addition & 1 deletion src/utils/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export type UserConfig = Partial<{
* Get the release description.
*
* Used as pull-request and release description.
* By default it's `Release of ${version}`
* By default it's the changelog part of the current / next version.
*/
getReleaseDescription: (ctx: HookContext) => PromiseOrValue<string>;

Expand Down

0 comments on commit 20e9304

Please sign in to comment.