chore: add option to provide fixed release name and changelog path

action.yml

@@ -28,6 +28,12 @@ inputs:
     description: "A boolean value to indicate whether to create Github releases after `publish` or not"
     required: false
     default: true
+  releaseVersion:
+    description: Use this if you want to provide a static release version
+    required: false
+  changelogPath:
+    description: The path of where the changelog file will be created
+    required: false
 outputs:
   published:
     description: A boolean value to indicate whether a publishing is happened or not

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@changesets/action",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "main": "dist/index.js",
   "license": "MIT",
   "devDependencies": {

src/__snapshots__/run.test.ts.snap

@@ -4,26 +4,7 @@ exports[`version creates simple PR 1`] = `
 Array [
   Object {
     "base": "some-branch",
-    "body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
-
-# Releases
-## [email protected]
-
-### Minor Changes
-
--   Awesome feature
-
-### Patch Changes
-
--   Updated dependencies
-    -   [email protected]
-
- ## [email protected]
-
-### Minor Changes
-
--   Awesome feature
-",
+    "body": "See [docs/releases/vundefined-changelog.md](https://github.com/backstage/backstage/blob/master/docs/releases/vundefined-changelog.md) for more information.",
     "head": "changeset-release/some-branch",
     "owner": "changesets",
     "repo": "action",
@@ -36,15 +17,7 @@ exports[`version doesn't include ignored package that got a dependency update in
 Array [
   Object {
     "base": "some-branch",
-    "body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
-
-# Releases
-## [email protected]
-
-### Minor Changes
-
--   Awesome feature
-",
+    "body": "See [docs/releases/vundefined-changelog.md](https://github.com/backstage/backstage/blob/master/docs/releases/vundefined-changelog.md) for more information.",
     "head": "changeset-release/some-branch",
     "owner": "changesets",
     "repo": "action",
@@ -57,15 +30,7 @@ exports[`version only includes bumped packages in the PR body 1`] = `
 Array [
   Object {
     "base": "some-branch",
-    "body": "This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to some-branch, this PR will be updated.
-
-# Releases
-## [email protected]
-
-### Minor Changes
-
--   Awesome feature
-",
+    "body": "See [docs/releases/vundefined-changelog.md](https://github.com/backstage/backstage/blob/master/docs/releases/vundefined-changelog.md) for more information.",
     "head": "changeset-release/some-branch",
     "owner": "changesets",
     "repo": "action",

src/index.ts

@@ -102,6 +102,8 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
         githubToken,
         prTitle: getOptionalInput("title"),
         commitMessage: getOptionalInput("commit"),
+        releaseVersion: getOptionalInput("releaseVersion"),
+        changelogPath: getOptionalInput("changelogPath"),
         hasPublishScript,
       });
 

src/run.ts

@@ -175,6 +175,8 @@ type VersionOptions = {
   prTitle?: string;
   commitMessage?: string;
   hasPublishScript?: boolean;
+  changelogPath?: string;
+  releaseVersion?: string;
 };
 
 type RunVersionResult = {
@@ -185,9 +187,11 @@ export async function runVersion({
   script,
   githubToken,
   cwd = process.cwd(),
+  releaseVersion,
   prTitle = "Version Packages",
   commitMessage = "Version Packages",
   hasPublishScript = false,
+  changelogPath = "docs/releases",
 }: VersionOptions): Promise<RunVersionResult> {
   let repo = `${github.context.repo.owner}/${github.context.repo.repo}`;
   let branch = github.context.ref.replace("refs/heads/", "");
@@ -219,9 +223,10 @@ export async function runVersion({
   });
   let changedPackages = await getChangedPackages(cwd, versionsByDirectory);
 
-  const { version: releaseVersion } = await fs.readJson(
+  const { version: versionFromPackageJson } = await fs.readJson(
     path.resolve(cwd, "package.json")
   );
+  const toUseReleaseVersion = releaseVersion || versionFromPackageJson;
 
   const changelogEntries = await Promise.all(
     changedPackages.map(async (pkg) => {
@@ -241,9 +246,9 @@ export async function runVersion({
     })
   );
   let changelogBody = `
-# Release v${releaseVersion}
+# Release v${toUseReleaseVersion}
 
-Upgrade Helper: [https://backstage.github.io/upgrade-helper/?to=${releaseVersion}](https://backstage.github.io/upgrade-helper/?to=${releaseVersion})
+Upgrade Helper: [https://backstage.github.io/upgrade-helper/?to=${toUseReleaseVersion}](https://backstage.github.io/upgrade-helper/?to=${toUseReleaseVersion})
 
 ${changelogEntries
   .filter((x) => x)
@@ -252,7 +257,8 @@ ${changelogEntries
   .join("\n")}
 `;
 
-  const changelogPath = `docs/releases/v${releaseVersion}-changelog.md`;
+  const file = `v${releaseVersion}-changelog.md`;
+  const fullChangelogPath = `${changelogPath}/${file}`;
 
   try {
     const prettier = require(resolveFrom(cwd, "prettier"));
@@ -263,9 +269,9 @@ ${changelogEntries
     });
   } catch {}
 
-  await fs.writeFile(changelogPath, changelogBody);
+  await fs.writeFile(fullChangelogPath, changelogBody);
 
-  const prBody = `See [${changelogPath}](https://github.com/backstage/backstage/blob/master/${changelogPath}) for more information.`;
+  const prBody = `See [${fullChangelogPath}](https://github.com/backstage/backstage/blob/master/${fullChangelogPath}) for more information.`;
 
   const finalPrTitle = `${prTitle}${!!preState ? ` (${preState.tag})` : ""}`;