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.

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

Flagged prerelease bump fix #97

Merged
merged 5 commits into from
Oct 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,13 @@ Alternatively some options may be set via CLI flags.

### `deps` Options

| Option | Type | CLI Flag | Description |
| ------ | ---- | -------- | ----------- |
| bump | `override \| satisfy \| inherit` | `--deps.bump` | Define deps version updating rule. Allowed: override, satisfy, inherit. **`override` by default.** |
| release | `patch \| minor \| major \| inherit` | `--deps.release` | Define release type for dependent package if any of its deps changes. Supported values: patch, minor, major, inherit. **`patch` by default** |
| prefix | `'^' \| '~' \| ''` | `--deps.prefix` | Optional prefix to be attached to the next version if `bump` is set to `override`. **`''` by default**. |
| Option | Type | CLI Flag | Description |
|-----------------------|--------------------------------------|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| bump | `override \| satisfy \| inherit` | `--deps.bump` | Define deps version updating rule. Allowed: override, satisfy, inherit. **`override` by default.** |
| release | `patch \| minor \| major \| inherit` | `--deps.release` | Define release type for dependent package if any of its deps changes. Supported values: patch, minor, major, inherit. **`patch` by default** |
| prefix | `'^' \| '~' \| ''` | `--deps.prefix` | Optional prefix to be attached to the next version if `bump` is set to `override`. **`''` by default**. |
| pullTagsForPrerelease | `boolean` | `--deps.pullTagsForPrerelease` | Optional flag to use release tags for evaluating prerelease version bumping. Normally, this option will lead to dumping dependencies to a version past what was just released and tagged by semantic release. Only set this option to true if you previously had a workflow that compensated for the previous bug behavior. **`'false'` by default**. |


### Examples

Expand Down
4 changes: 4 additions & 0 deletions bin/cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +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.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]"
Expand Down Expand Up @@ -59,6 +60,9 @@ const cli = meow(
"deps.prefix": {
type: "string",
},
"deps.pullTagsForPrerelease": {
type: "boolean",
},
ignorePrivate: {
type: "boolean",
},
Expand Down
25 changes: 24 additions & 1 deletion lib/getConfigMultiSemrel.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,28 @@ import { cosmiconfig } from "cosmiconfig";
import { pickBy, isNil, castArray, uniq } from "lodash-es";
import { createRequire } from "node:module";

/**
* @typedef {Object} DepsConfig
* @property {'override' | 'satisfy' | 'inherit'} bump
* @property {'patch' | 'minor' | 'major' | 'inherit'} release
* @property {'^' | '~' | ''} prefix
* @property {boolean} pullTagsForPrerelease
*/

/**
* @typedef {Object} MultiReleaseConfig
* @property {boolean} sequentialInit
* @property {boolean} sequentialPrepare
* @property {boolean} firstParent
* @property {boolean} debug
* @property {boolean} ignorePrivate
* @property {Array<string>} ignorePackages
* @property {string} tagFormat
* @property {boolean} dryRun
* @property {DepsConfig} deps
* @property {boolean} silent
*/

const CONFIG_NAME = "multi-release";
const CONFIG_FILES = [
"package.json",
Expand Down Expand Up @@ -36,7 +58,7 @@ const mergeConfig = (a = {}, b = {}) => {
*
* @param {string} cwd The directory to search.
* @param {Object} cliOptions cli supplied options.
* @returns {Object} The found configuration option
* @returns {MultiReleaseConfig} The found configuration option
*
* @internal
*/
Expand Down Expand Up @@ -72,6 +94,7 @@ export default async function getConfig(cwd, cliOptions) {
bump: "override",
release: "patch",
prefix: "",
pullTagsForPrerelease: false,
},
silent: false,
},
Expand Down
32 changes: 28 additions & 4 deletions lib/multiSemanticRelease.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ import { createRequire } from "module";
* @param {Package[]} localDeps Array of local dependencies this package relies on.
* @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} 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)
*/

/**
Expand Down Expand Up @@ -83,7 +87,15 @@ async function multiSemanticRelease(

// Vars.
const globalOptions = await getConfig(cwd);
const multiContext = { globalOptions, inputOptions, cwd, env, stdout, stderr };
const multiContext = {
globalOptions,
inputOptions,
cwd,
env,
stdout,
stderr,
pullTagsForPrerelease: flags.deps.pullTagsForPrerelease,
};
const { queue, packages: _packages } = await topo({
cwd,
workspacesExtra: Array.isArray(flags.ignorePackages) ? flags.ignorePackages.map((p) => `!${p}`) : [],
Expand Down Expand Up @@ -141,7 +153,7 @@ async function multiSemanticRelease(
*
* @internal
*/
async function getPackage(path, { globalOptions, inputOptions, env, cwd, stdout, stderr }) {
async function getPackage(path, { globalOptions, inputOptions, env, cwd, stdout, stderr, pullTagsForPrerelease }) {
// Make path absolute.
path = cleanPath(path, cwd);
const dir = dirname(path);
Expand Down Expand Up @@ -173,7 +185,17 @@ async function getPackage(path, { globalOptions, inputOptions, env, cwd, stdout,
const { options, plugins } = await getConfigSemantic({ cwd: dir, env, stdout, stderr }, finalOptions);

// Return package object.
return { path, dir, name, manifest, deps, options, plugins, fakeLogger: fakeLogger };
return {
path,
dir,
name,
manifest,
deps,
options,
plugins,
fakeLogger: fakeLogger,
pullTagsForPrerelease: !!pullTagsForPrerelease,
};
}

/**
Expand Down Expand Up @@ -239,7 +261,9 @@ async function releasePackage(pkg, createInlinePlugin, multiContext, flags) {

function normalizeFlags(_flags) {
return {
deps: {},
deps: {
pullTagsForPrerelease: !!_flags.deps?.pullTagsForPrerelease,
},
..._flags,
};
}
Expand Down
38 changes: 25 additions & 13 deletions lib/updateDeps.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,40 +44,52 @@ const getVersionFromTag = (pkg, tag) => {
/**
* Resolve next package version on prereleases.
*
* Will resolve highest next version of either:
*
* 1. The last release for the package during this multi-release cycle
* 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
*
* @param {Package} pkg Package object.
* @param {Array<string>} tags Override list of tags from specific pkg and branch.
* @returns {string|undefined} Next pkg version.
* @internal
*/
const getNextPreVersion = (pkg, tags) => {
const tagFilters = [pkg._preRelease];
const lastVersion = pkg._lastRelease && pkg._lastRelease.version;
// Note: this is only set is a current multi-semantic-release released
const lastVersionForCurrentRelease = pkg._lastRelease && pkg._lastRelease.version;

if (!pkg.pullTagsForPrerelease && tags) {
throw new Error("Supplied tags for NextPreVersion but the package does not use tags for next prerelease");
}

// Extract tags:
// 1. Set filter to extract only package tags
// 2. Get tags from a branch considering the filters established
// 3. Resolve the versions from the tags
// TODO: replace {cwd: '.'} with multiContext.cwd
if (pkg.name) tagFilters.push(pkg.name);
if (!tags) {
if (!tags && pkg.pullTagsForPrerelease) {
try {
tags = getTags(pkg._branch, { cwd: process.cwd() }, tagFilters);
tags = getTags(pkg._branch, { cwd: pkg.dir }, tagFilters);
} catch (e) {
tags = [];
console.warn(e);
console.warn(`Try 'git pull ${pkg._branch}'`);
}
}

const lastPreRelTag = getPreReleaseTag(lastVersion);
const lastPreRelTag = getPreReleaseTag(lastVersionForCurrentRelease);
const isNewPreRelTag = lastPreRelTag && lastPreRelTag !== pkg._preRelease;

const versionToSet =
isNewPreRelTag || !lastVersion
isNewPreRelTag || !lastVersionForCurrentRelease
? `1.0.0-${pkg._preRelease}.1`
: _nextPreVersionCases(
tags.map((tag) => getVersionFromTag(pkg, tag)).filter((tag) => tag),
lastVersion,
tags ? tags.map((tag) => getVersionFromTag(pkg, tag)).filter((tag) => tag) : [],
lastVersionForCurrentRelease,
pkg._nextType,
pkg._preRelease
);
Expand All @@ -101,23 +113,23 @@ const getPreReleaseTag = (version) => {
/**
* Resolve next prerelease special cases: highest version from tags or major/minor/patch.
*
* @param {Array} tags List of all released tags from package.
* @param {string} lastVersion Last package version released.
* @param {Array<string>} tags - if non-empty, we will use these tags as part fo the comparison
* @param {string} lastVersionForCurrentMultiRelease Last package version released from multi-semantic-release
* @param {string} pkgNextType Next type evaluated for the next package type.
* @param {string} pkgPreRelease Package prerelease suffix.
* @returns {string|undefined} Next pkg version.
* @internal
*/
const _nextPreVersionCases = (tags, lastVersion, pkgNextType, pkgPreRelease) => {
const _nextPreVersionCases = (tags, lastVersionForCurrentMultiRelease, pkgNextType, pkgPreRelease) => {
// Case 1: Normal release on last version and is now converted to a prerelease
if (!semver.prerelease(lastVersion)) {
const { major, minor, patch } = semver.parse(lastVersion);
if (!semver.prerelease(lastVersionForCurrentMultiRelease)) {
const { major, minor, patch } = semver.parse(lastVersionForCurrentMultiRelease);
return `${semver.inc(`${major}.${minor}.${patch}`, pkgNextType || "patch")}-${pkgPreRelease}.1`;
}

// Case 2: Validates version with tags
const latestTag = getLatestVersion(tags, { withPrerelease: true });
return _nextPreHighestVersion(latestTag, lastVersion, pkgPreRelease);
return _nextPreHighestVersion(latestTag, lastVersionForCurrentMultiRelease, pkgPreRelease);
};

/**
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"lint": "eslint ./",
"lint:fix": "eslint --fix ./",
"test": "yarn lint && yarn test:unit",
"test:unit": "NODE_OPTIONS=--experimental-vm-modules ./node_modules/.bin/jest --coverage",
"test:unit": "NODE_OPTIONS=\"${NODE_OPTIONS} --experimental-vm-modules\" ./node_modules/.bin/jest --coverage",
"build": "echo 'There is no need for build' && exit 0",
"postupdate": "yarn && npx yarn-audit-fix && yarn build && yarn test",
"publish:beta": "npm publish --no-git-tag-version --tag beta"
Expand Down
11 changes: 9 additions & 2 deletions test/helpers/file.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { basename, join } from "path";
import { basename, join, resolve } from "path";
import { copyFileSync, existsSync, mkdirSync, lstatSync, readdirSync, readFileSync, writeFileSync } from "fs";

// Deep copy a directory.
Expand Down Expand Up @@ -44,5 +44,12 @@ function createNewTestingFiles(folders, cwd) {
});
}

function addPrereleaseToPackageRootConfig(rootDir, releaseBranch) {
const packageUri = resolve(join(rootDir, "package.json"));
const packageJson = JSON.parse(readFileSync(packageUri).toString());

packageJson.release.branches = ["master", { name: releaseBranch, prerelease: true }];
}

// Exports.
export { copyDirectory, isDirectory, createNewTestingFiles };
export { copyDirectory, isDirectory, createNewTestingFiles, addPrereleaseToPackageRootConfig };
Loading
Loading