Skip to content

feat(version): configurable pr-body - #727

Open
furcan wants to merge 4 commits into
changesets:mainfrom
furcan:feature/configurable-pr-body
Open

feat(version): configurable pr-body#727
furcan wants to merge 4 commits into
changesets:mainfrom
furcan:feature/configurable-pr-body

Conversation

@furcan

@furcan furcan commented Aug 24, 2026

Copy link
Copy Markdown

Context

There are some open discussions around it but no outcome or decisions.

Changesets as developer-intent release management tool can be used/in-use broader then only NPM Packages.
if package.json present, and SemVer is a preferred version management for any project, this tool (from CLI to Action) can be used.

The current PR description with pre-state, max content length etc explicitly targeting NPM and Publishing to an NPM artifactory types of wordings.

Changes

What this PR does is

  • respecting entire logic as is, not creates any regression
  • introducing an optional pr-body input, as following the same naming convention that is picked since v2.
  • allowing consumers to use {PACKAGES_INFO} special identifier in anywhere they want to use in their custom PR body text. THIS_AND_THAT \n{PACKAGES_INFO} or just WHATEVER

Additional Code Changes

I can revert these if owners/maintainers don't likes

  • isObject util moved from run.ts to utils.ts, extended with array check
  • isString util added for new prBody to allow explicitly only string when runtime
  • non-executable code(types) moved to run.types.ts file for the touched functions => getVersionPrBody + runVersion
    • to keep the file simple and readable and by the intent, its runtime code, not build time.

Whats remaining

  • Get review from owners
  • Document this addition on READMEs and related workflows inputs(if any)
  • add a changesets entry as minor for this action

@changeset-bot

changeset-bot Bot commented Aug 24, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 6df6b3f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@furcan furcan changed the title feature: configurable pr-body feat(version): configurable pr-body Aug 24, 2026
@furcan

furcan commented Aug 26, 2026

Copy link
Copy Markdown
Author

CC: @Andarist

Thank you in advance 🙇

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant