chore: rn useTagsForBump → pullTagsForPrerelease

bin/cli.js

@@ -20,7 +20,7 @@ const cli = meow(
     --deps.bump Define deps version updating rule. Allowed: override, satisfy, inherit.
     --deps.release Define release type for dependent package if any of its deps changes. Supported values: patch, minor, major, inherit.
     --deps.prefix Optional prefix to be attached to the next dep version if '--deps.bump' set to 'override'. Supported values: '^' | '~' | '' (empty string as default).
-	--deps.useTagsForBump Optional flag to skip using release tags for evaluating prerelease version bumping.  This is almost always the correct option since semantic-relesae will be creating tags for every dependency and it would lead to us bumping to a non-existent version.  Set to false if you've already compensated for this in your workflow previously (true as default)
+    --deps.pullTagsForPrerelease Optional flag to control using release tags for evaluating prerelease version bumping.  This is almost always the correct option since semantic-release will be creating tags for every dependency and it would lead to us bumping to a non-existent version.  Set to false if you've already compensated for this in your workflow previously (true as default)
     --ignore-packages  Packages list to be ignored on bumping process
     --ignore-private Exclude private packages. Enabled by default, pass 'no-ignore-private' to disable.
     --tag-format Format to use for creating tag names. Should include "name" and "version" vars. Default: "\${name}@\${version}" generates "[email protected]"
@@ -60,7 +60,7 @@ const cli = meow(
 			"deps.prefix": {
 				type: "string",
 			},
-			"deps.useTagsForBump": {
+			"deps.pullTagsForPrerelease": {
 				type: "boolean",
 			},
 			ignorePrivate: {

lib/getConfigMultiSemrel.js

@@ -8,7 +8,7 @@ import { createRequire } from "node:module";
  * @property {'override' | 'satisfy' | 'inherit'} bump
  * @property {'patch' | 'minor' | 'major' | 'inherit'} release
  * @property {'^' | '~' | ''} prefix
- * @property {boolean} useTagsForBump
+ * @property {boolean} pullTagsForPrerelease
  */
 
 /**
@@ -94,7 +94,7 @@ export default async function getConfig(cwd, cliOptions) {
 				bump: "override",
 				release: "patch",
 				prefix: "",
-				useTagsForBump: false,
+				pullTagsForPrerelease: false,
 			},
 			silent: false,
 		},

lib/multiSemanticRelease.js

@@ -36,7 +36,7 @@ import { createRequire } from "module";
  * @param {context|void} context The semantic-release context for this package's release (filled in once semantic-release runs).
  * @param {undefined|Result|false} result The result of semantic-release (object with lastRelease, nextRelease, commits, releases), false if this package was skipped (no changes or similar), or undefined if the package's release hasn't completed yet.
  * @param {Object} options Aggregate of semantic-release options for the package
- * @param {boolean} useTagsForBump if set to true, the package will use tags to determine if its dependencies need to change (legacy functionality)
+ * @param {boolean} pullTagsForPrerelease if set to true, the package will use tags to determine if its dependencies need to change (legacy functionality)
  * @param {Object} _lastRelease The last release object for the package before its current release (set during anaylze-commit)
  * @param {Object} _nextRelease The next release object (the release the package is releasing for this cycle) (set during generateNotes)
  */
@@ -94,7 +94,7 @@ async function multiSemanticRelease(
 		env,
 		stdout,
 		stderr,
-		useTagsForBump: flags.deps.useTagsForBump,
+		pullTagsForPrerelease: flags.deps.pullTagsForPrerelease,
 	};
 	const { queue, packages: _packages } = await topo({
 		cwd,
@@ -153,7 +153,7 @@ async function multiSemanticRelease(
  *
  * @internal
  */
-async function getPackage(path, { globalOptions, inputOptions, env, cwd, stdout, stderr, useTagsForBump }) {
+async function getPackage(path, { globalOptions, inputOptions, env, cwd, stdout, stderr, pullTagsForPrerelease }) {
 	// Make path absolute.
 	path = cleanPath(path, cwd);
 	const dir = dirname(path);
@@ -194,7 +194,7 @@ async function getPackage(path, { globalOptions, inputOptions, env, cwd, stdout,
 		options,
 		plugins,
 		fakeLogger: fakeLogger,
-		useTagsForBump: !!useTagsForBump,
+		pullTagsForPrerelease: !!pullTagsForPrerelease,
 	};
 }
 
@@ -262,7 +262,7 @@ async function releasePackage(pkg, createInlinePlugin, multiContext, flags) {
 function normalizeFlags(_flags) {
 	return {
 		deps: {
-			useTagsForBump: !!_flags.deps?.useTagsForBump,
+			pullTagsForPrerelease: !!_flags.deps?.pullTagsForPrerelease,
 		},
 		..._flags,
 	};

lib/updateDeps.js

@@ -47,7 +47,7 @@ const getVersionFromTag = (pkg, tag) => {
  * Will resolve highest next version of either:
  *
  * 1. The last release for the package during this multi-release cycle
- * 2. (if the package has useTagsForBump true):
+ * 2. (if the package has pullTagsForPrerelease true):
  *   a. the highest increment of the tags array provided
  *   b. the highest increment of the gitTags for the prerelease
  *
@@ -61,7 +61,7 @@ const getNextPreVersion = (pkg, tags) => {
 	// Note: this is only set is a current multi-semantic-release released
 	const lastVersionForCurrentRelease = pkg._lastRelease && pkg._lastRelease.version;
 
-	if (!pkg.useTagsForBump && tags) {
+	if (!pkg.pullTagsForPrerelease && tags) {
 		throw new Error("Supplied tags for NextPreVersion but the package does not use tags for next prerelease");
 	}
 
@@ -71,7 +71,7 @@ const getNextPreVersion = (pkg, tags) => {
 	// 3. Resolve the versions from the tags
 	// TODO: replace {cwd: '.'} with multiContext.cwd
 	if (pkg.name) tagFilters.push(pkg.name);
-	if (!tags && pkg.useTagsForBump) {
+	if (!tags && pkg.pullTagsForPrerelease) {
 		try {
 			tags = getTags(pkg._branch, { cwd: pkg.dir }, tagFilters);
 		} catch (e) {

test/lib/multiSemanticRelease.test.js

@@ -1061,7 +1061,7 @@ describe("multiSemanticRelease()", () => {
 	});
 
 	// Bug state that we want to keep for now in case of other people who have triaged it
-	test("Changes in some packages with bugged prerelease bumping (useTagsForBump: true)", async () => {
+	test("Changes in some packages with bugged prerelease bumping (pullTagsForPrerelease: true)", async () => {
 		const preReleaseBranch = "alpha";
 		// Create Git repo.
 		const cwd = gitInit(preReleaseBranch);
@@ -1097,7 +1097,7 @@ describe("multiSemanticRelease()", () => {
 			{ cwd, stdout, stderr, env },
 			{
 				deps: {
-					useTagsForBump: true,
+					pullTagsForPrerelease: true,
 				},
 				dryRun: false,
 			}
@@ -1232,7 +1232,7 @@ describe("multiSemanticRelease()", () => {
 			{ cwd, stdout: stdout2, stderr: stderr2, env },
 			{
 				deps: {
-					useTagsForBump: true,
+					pullTagsForPrerelease: true,
 				},
 				dryRun: false,
 			}

test/lib/updateDeps.test.js

@@ -246,7 +246,7 @@ describe("getNextPreVersion()", () => {
 					_preRelease: preRelease,
 					_branch: "master",
 					name: "testing-package",
-					useTagsForBump: true,
+					pullTagsForPrerelease: true,
 				},
 				lastTags,
 			)).toBe(nextVersion);
@@ -265,14 +265,14 @@ describe("getNextPreVersion()", () => {
 					_preRelease: preRelease,
 					_branch: "master",
 					name: "testing-package",
-					useTagsForBump: true,
+					pullTagsForPrerelease: true,
 				},
 				// No Tags array means we look them up
 			)).toBe(nextVersion);
 			expect(getTags).toHaveBeenCalledTimes(1);
 		});
 	});
-	it("does not allow tags if useTagsForBump = false", () => {
+	it("does not allow tags if pullTagsForPrerelease = false", () => {
 		expect(() =>
 			getNextPreVersion(
 				{
@@ -281,7 +281,7 @@ describe("getNextPreVersion()", () => {
 					_preRelease: "dev",
 					_branch: "master",
 					name: "testing-package",
-					useTagsForBump: false,
+					pullTagsForPrerelease: false,
 				},
 				[]
 			)
@@ -301,7 +301,7 @@ describe("getNextPreVersion()", () => {
 		["1.0.0", "patch", "beta", "1.0.1-beta.1"],
 	];
 	noTagCases.forEach(([lastVersion, releaseType, preRelease, nextVersion]) => {
-		it(`${lastVersion} and ${releaseType} for channel ${preRelease} gives ${nextVersion} when useTagsForBump = false`, () => {
+		it(`${lastVersion} and ${releaseType} for channel ${preRelease} gives ${nextVersion} when pullTagsForPrerelease = false`, () => {
 			// prettier-ignore
 			expect(getNextPreVersion(
 				{
@@ -310,7 +310,7 @@ describe("getNextPreVersion()", () => {
 					_preRelease: preRelease,
 					_branch: "master",
 					name: "testing-package",
-					useTagsForBump: false,
+					pullTagsForPrerelease: false,
 				},
 			)).toBe(nextVersion);
 		});