Skip to content

chore(0.77): use fallback resolver for new tags #2415

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.

Sign up for GitHub

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

Merged
Saadnajmi merged 2 commits into from
Mar 13, 2025
Merged

chore(0.77): use fallback resolver for new tags #2415

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41c9c74
chore: use fallback resolver for new tags (#2414)
tido64 Mar 13, 2025
e25953a
Merge branch '0.77-stable' into falback-77
Saadnajmi Mar 13, 2025
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
82 changes: 58 additions & 24 deletions .ado/scripts/prepublish-check.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,20 @@ const NX_CONFIG_FILE = "nx.json";
const NPM_TAG_NEXT = "next";
const NPM_TAG_NIGHTLY = "nightly";
const RNMACOS_LATEST = "react-native-macos@latest";
const RNMACOS_NEXT = "react-native-macos@next";

/**
* @typedef {typeof import("../../nx.json")} NxConfig
* @typedef {{ tag?: string; update?: boolean; verbose?: boolean; }} Options
* @typedef {import("nx/src/command-line/release/version").ReleaseVersionGeneratorSchema} ReleaseVersionGeneratorSchema;
* @typedef {{
* defaultBase: string;
* release: {
* version: {
* generatorOptions: ReleaseVersionGeneratorSchema;
* };
* };
* }} NxConfig;
* @typedef {{ tag?: string; update?: boolean; verbose?: boolean; }} Options;
* @typedef {{ npmTag: string; prerelease?: string; isNewTag?: boolean; }} TagInfo;
*/

/**
Expand Down Expand Up @@ -100,10 +110,11 @@ function getCurrentBranch() {

/**
* Returns the latest published version of `react-native-macos` from npm.
* @param {"latest" | "next"} tag
* @returns {number}
*/
function getLatestVersion() {
const { stdout } = spawnSync("npm", ["view", RNMACOS_LATEST, "version"]);
function getPublishedVersion(tag) {
const { stdout } = spawnSync("npm", ["view", `react-native-macos@${tag}`, "version"]);
return versionToNumber(stdout.toString().trim());
}

Expand All @@ -118,14 +129,14 @@ function getLatestVersion() {
* @param {string} branch
* @param {Options} options
* @param {typeof info} log
* @returns {{ npmTag: string; prerelease?: string; }}
* @returns {TagInfo}
*/
function getTagForStableBranch(branch, { tag }, log) {
if (!isStableBranch(branch)) {
throw new Error("Expected a stable branch");
}

const latestVersion = getLatestVersion();
const latestVersion = getPublishedVersion("latest");
const currentVersion = versionToNumber(branch);

log(`${RNMACOS_LATEST}: ${latestVersion}`);
Expand All @@ -138,11 +149,14 @@ function getTagForStableBranch(branch, { tag }, log) {
return { npmTag };
}

// Patching an older stable version
// Demoting or patching an older stable version
if (currentVersion < latestVersion) {
const npmTag = "v" + branch;
log(`Expected npm tag: ${npmTag}`);
return { npmTag };
// If we're demoting a branch, we will need to create a new tag. This will
// make Nx trip if we don't specify a fallback. In all other scenarios, the
// tags should exist and therefore prefer it to fail.
return { npmTag, isNewTag: true };
}

// Publishing a new latest version
Expand All @@ -152,7 +166,14 @@ function getTagForStableBranch(branch, { tag }, log) {
}

// Publishing a release candidate
const nextVersion = getPublishedVersion("next");
log(`${RNMACOS_NEXT}: ${nextVersion}`);
log(`Expected npm tag: ${NPM_TAG_NEXT}`);

if (currentVersion < nextVersion) {
throw new Error(`Current version cannot be a release candidate because it is too old: ${currentVersion} < ${nextVersion}`);
}

return { npmTag: NPM_TAG_NEXT, prerelease: "rc" };
}

Expand All @@ -163,25 +184,24 @@ function getTagForStableBranch(branch, { tag }, log) {
*/
function verifyPublishPipeline(file, tag) {
const data = fs.readFileSync(file, { encoding: "utf-8" });
const m = data.match(/publishTag: '(\w*?)'/);
const m = data.match(/publishTag: '(latest|next|nightly|v\d+\.\d+-stable)'/);
if (!m) {
throw new Error(`${file}: Could not find npm publish tag`);
}

if (m[1] !== tag) {
throw new Error(`${file}: 'publishTag' needs to be set to '${tag}'`);
throw new Error(`${file}: 'publishTag' must be set to '${tag}'`);
}
}

/**
* Verifies the configuration and enables publishing on CI.
* @param {NxConfig} config
* @param {string} currentBranch
* @param {string} tag
* @param {string} [prerelease]
* @param {TagInfo} tag
* @returns {asserts config is NxConfig["release"]}
*/
function enablePublishing(config, currentBranch, tag, prerelease) {
function enablePublishing(config, currentBranch, { npmTag: tag, prerelease, isNewTag }) {
/** @type {string[]} */
const errors = [];

Expand All @@ -196,21 +216,35 @@ function enablePublishing(config, currentBranch, tag, prerelease) {
}

// Determines whether we need to add "nightly" or "rc" to the version string.
const { currentVersionResolverMetadata, preid } = release.version.generatorOptions;
if (preid !== prerelease) {
const { generatorOptions } = release.version;
if (generatorOptions.preid !== prerelease) {
errors.push(`'release.version.generatorOptions.preid' must be set to '${prerelease || ""}'`);
if (prerelease) {
release.version.generatorOptions.preid = prerelease;
generatorOptions.preid = prerelease;
} else {
// @ts-expect-error `preid` is optional
release.version.generatorOptions.preid = undefined;
generatorOptions.preid = undefined;
}
}

// What the published version should be tagged as e.g., "latest" or "nightly".
if (currentVersionResolverMetadata.tag !== tag) {
const { currentVersionResolverMetadata } = generatorOptions;
if (currentVersionResolverMetadata?.tag !== tag) {
errors.push(`'release.version.generatorOptions.currentVersionResolverMetadata.tag' must be set to '${tag}'`);
release.version.generatorOptions.currentVersionResolverMetadata.tag = tag;
generatorOptions.currentVersionResolverMetadata ??= {};
generatorOptions.currentVersionResolverMetadata.tag = tag;
}

// If we're demoting a branch, we will need to create a new tag. This will
// make Nx trip if we don't specify a fallback. In all other scenarios, the
// tags should exist and therefore prefer it to fail.
if (isNewTag) {
if (generatorOptions.fallbackCurrentVersionResolver !== "disk") {
errors.push("'release.version.generatorOptions.fallbackCurrentVersionResolver' must be set to 'disk'");
generatorOptions.fallbackCurrentVersionResolver = "disk";
}
} else if (typeof generatorOptions.fallbackCurrentVersionResolver === "string") {
errors.push("'release.version.generatorOptions.fallbackCurrentVersionResolver' must be unset");
generatorOptions.fallbackCurrentVersionResolver = undefined;
}

if (errors.length > 0) {
Expand Down Expand Up @@ -238,10 +272,10 @@ function main(options) {
const config = loadNxConfig(NX_CONFIG_FILE);
try {
if (isMainBranch(branch)) {
enablePublishing(config, branch, NPM_TAG_NIGHTLY, NPM_TAG_NIGHTLY);
enablePublishing(config, branch, { npmTag: NPM_TAG_NIGHTLY, prerelease: NPM_TAG_NIGHTLY });
} else if (isStableBranch(branch)) {
const { npmTag, prerelease } = getTagForStableBranch(branch, options, logger);
enablePublishing(config, branch, npmTag, prerelease);
const tag = getTagForStableBranch(branch, options, logger);
enablePublishing(config, branch, tag);
}
} catch (e) {
if (options.update) {
Expand Down Expand Up @@ -277,4 +311,4 @@ const { values } = util.parseArgs({
strict: true,
});

process.exitCode = main(values);
process.exitCode = main(values);