@release-change/ci 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present Victor Brito
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,24 @@
+# @release-change/ci
+
+Get environment variables related to the CI
+
+![License: MIT](https://img.shields.io/github/license/release-change/release-change)
+[![ESM-only package](https://img.shields.io/badge/package-ESM--only-ffe536)](https://nodejs.org/api/esm.html)
+[![Conventional Commits 1.0.0](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
+[![Formatted with Biome](https://img.shields.io/badge/Formatted_with-Biome-60a5fa?style=flat&logo=biome)](https://biomejs.dev/)
+![NPM latest version](https://img.shields.io/npm/v/%40release-change%2Fci/latest)
+![Node support](https://img.shields.io/node/v/%40release-change%2Fci)
+![Build status](https://img.shields.io/github/actions/workflow/status/release-change/release-change/run-tests.yml)
+
+## Properties
+
+- `isCi`: `true` if the current environment is a CI environment, `false` otherwise;
+- `isPullRequest`: `true` if the current event is triggered by a pull request, `false` otherwise.
+
+## Supported CI environments
+
+- [GitHub Actions](https://docs.github.com/en/actions/reference/workflows-and-actions/variables#default-environment-variables).
+
+## Copyright & licence
+
+© 2025-present Victor Brito — Released under the [MIT licence](./LICENSE).

package/dist/configure-ci-environment.d.ts

@@ -0,0 +1,8 @@
+import type { CiConfig } from "@release-change/shared";
+/**
+ * Configures CI environment.
+ * @param env - The whole available environment variables.
+ * @return An object with `isCi` and `isPullRequest` properties set to the boolean suiting the context.
+ */
+export declare const configureCiEnvironment: (env: NodeJS.ProcessEnv) => CiConfig;
+//# sourceMappingURL=configure-ci-environment.d.ts.map

package/dist/configure-ci-environment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configure-ci-environment.d.ts","sourceRoot":"","sources":["../src/configure-ci-environment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAIvD;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GAAI,KAAK,MAAM,CAAC,UAAU,KAAG,QAa/D,CAAC"}

package/dist/configure-ci-environment.js

@@ -0,0 +1,20 @@
+import { isCiToolDetected } from "./is-ci-tool-detected.js";
+/**
+ * Configures CI environment.
+ * @param env - The whole available environment variables.
+ * @return An object with `isCi` and `isPullRequest` properties set to the boolean suiting the context.
+ */
+export const configureCiEnvironment = (env) => {
+    if (isCiToolDetected(env, "GITHUB_ACTIONS")) {
+        const isPullRequest = env.GITHUB_EVENT_NAME === "pull_request" || env.GITHUB_EVENT_NAME === "pull_request_target";
+        return {
+            isCi: Boolean(env.CI),
+            isPullRequest
+        };
+    }
+    return {
+        isCi: false,
+        isPullRequest: false
+    };
+};
+//# sourceMappingURL=configure-ci-environment.js.map

package/dist/configure-ci-environment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configure-ci-environment.js","sourceRoot":"","sources":["../src/configure-ci-environment.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAE5D;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,GAAsB,EAAY,EAAE;IACzE,IAAI,gBAAgB,CAAC,GAAG,EAAE,gBAAgB,CAAC,EAAE,CAAC;QAC5C,MAAM,aAAa,GACjB,GAAG,CAAC,iBAAiB,KAAK,cAAc,IAAI,GAAG,CAAC,iBAAiB,KAAK,qBAAqB,CAAC;QAC9F,OAAO;YACL,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACrB,aAAa;SACd,CAAC;IACJ,CAAC;IACD,OAAO;QACL,IAAI,EAAE,KAAK;QACX,aAAa,EAAE,KAAK;KACrB,CAAC;AACJ,CAAC,CAAC"}

package/dist/get-issue-and-pull-request-token.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Gets the token used to interact with issues and pull requests from the environment variables.
+ * @param env - The whole available environment variables.
+ * @return The token if the `ISSUE_PR_TOKEN` environment variable is defined.
+ */
+export declare const getIssueAndPullRequestToken: (env: NodeJS.ProcessEnv) => string;
+//# sourceMappingURL=get-issue-and-pull-request-token.d.ts.map

package/dist/get-issue-and-pull-request-token.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-issue-and-pull-request-token.d.ts","sourceRoot":"","sources":["../src/get-issue-and-pull-request-token.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,GAAI,KAAK,MAAM,CAAC,UAAU,KAAG,MAYpE,CAAC"}

package/dist/get-issue-and-pull-request-token.js

@@ -0,0 +1,20 @@
+import { formatDetailedError } from "@release-change/shared";
+/**
+ * Gets the token used to interact with issues and pull requests from the environment variables.
+ * @param env - The whole available environment variables.
+ * @return The token if the `ISSUE_PR_TOKEN` environment variable is defined.
+ */
+export const getIssueAndPullRequestToken = (env) => {
+    const { ISSUE_PR_TOKEN } = env;
+    if (ISSUE_PR_TOKEN)
+        return ISSUE_PR_TOKEN;
+    process.exitCode = 1;
+    throw formatDetailedError({
+        title: "Failed to get issue and pull request token",
+        message: "The token used to interact with issues and pull requests (comments, state and tags) is not defined.",
+        details: {
+            output: "env.ISSUE_PR_TOKEN: undefined"
+        }
+    });
+};
+//# sourceMappingURL=get-issue-and-pull-request-token.js.map

package/dist/get-issue-and-pull-request-token.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-issue-and-pull-request-token.js","sourceRoot":"","sources":["../src/get-issue-and-pull-request-token.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAE7D;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,GAAsB,EAAU,EAAE;IAC5E,MAAM,EAAE,cAAc,EAAE,GAAG,GAAG,CAAC;IAC/B,IAAI,cAAc;QAAE,OAAO,cAAc,CAAC;IAC1C,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACrB,MAAM,mBAAmB,CAAC;QACxB,KAAK,EAAE,4CAA4C;QACnD,OAAO,EACL,qGAAqG;QACvG,OAAO,EAAE;YACP,MAAM,EAAE,+BAA+B;SACxC;KACF,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/get-release-token.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Get the release token from the environment variables.
+ * @param env - The whole available environment variables.
+ * @return The token if the `RELEASE_TOKEN` environment variable is defined.
+ */
+export declare const getReleaseToken: (env: NodeJS.ProcessEnv) => string;
+//# sourceMappingURL=get-release-token.d.ts.map

package/dist/get-release-token.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-release-token.d.ts","sourceRoot":"","sources":["../src/get-release-token.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAI,KAAK,MAAM,CAAC,UAAU,KAAG,MAaxD,CAAC"}

package/dist/get-release-token.js

@@ -0,0 +1,21 @@
+import { formatDetailedError } from "@release-change/shared";
+/**
+ * Get the release token from the environment variables.
+ * @param env - The whole available environment variables.
+ * @return The token if the `RELEASE_TOKEN` environment variable is defined.
+ */
+export const getReleaseToken = (env) => {
+    const releaseToken = env.RELEASE_TOKEN;
+    if (!releaseToken) {
+        process.exitCode = 1;
+        throw formatDetailedError({
+            title: "Failed to get the release token",
+            message: "The release token is not defined.",
+            details: {
+                output: "env.RELEASE_TOKEN: undefined"
+            }
+        });
+    }
+    return releaseToken;
+};
+//# sourceMappingURL=get-release-token.js.map

package/dist/get-release-token.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-release-token.js","sourceRoot":"","sources":["../src/get-release-token.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAE7D;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,GAAsB,EAAU,EAAE;IAChE,MAAM,YAAY,GAAG,GAAG,CAAC,aAAa,CAAC;IACvC,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;QACrB,MAAM,mBAAmB,CAAC;YACxB,KAAK,EAAE,iCAAiC;YACxC,OAAO,EAAE,mCAAmC;YAC5C,OAAO,EAAE;gBACP,MAAM,EAAE,8BAA8B;aACvC;SACF,CAAC,CAAC;IACL,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { configureCiEnvironment } from "./configure-ci-environment.js";
+export { getIssueAndPullRequestToken } from "./get-issue-and-pull-request-token.js";
+export { getReleaseToken } from "./get-release-token.js";
+export { isUsableCiEnvironment } from "./is-usable-ci-environment.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC"}

package/dist/index.js

@@ -0,0 +1,5 @@
+export { configureCiEnvironment } from "./configure-ci-environment.js";
+export { getIssueAndPullRequestToken } from "./get-issue-and-pull-request-token.js";
+export { getReleaseToken } from "./get-release-token.js";
+export { isUsableCiEnvironment } from "./is-usable-ci-environment.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC"}

package/dist/is-ci-tool-detected.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks whether a CI tool is detected or not.
+ * @param env - The whole available environment variables.
+ * @param ciTool - The variable to find.
+ * @return `true` if a CI tool is found within the environment variables, `false` otherwise.
+ */
+export declare const isCiToolDetected: (env: NodeJS.ProcessEnv, ciTool: string) => boolean;
+//# sourceMappingURL=is-ci-tool-detected.d.ts.map

package/dist/is-ci-tool-detected.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-ci-tool-detected.d.ts","sourceRoot":"","sources":["../src/is-ci-tool-detected.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,KAAK,MAAM,CAAC,UAAU,EAAE,QAAQ,MAAM,KAAG,OAEzE,CAAC"}

package/dist/is-ci-tool-detected.js

@@ -0,0 +1,10 @@
+/**
+ * Checks whether a CI tool is detected or not.
+ * @param env - The whole available environment variables.
+ * @param ciTool - The variable to find.
+ * @return `true` if a CI tool is found within the environment variables, `false` otherwise.
+ */
+export const isCiToolDetected = (env, ciTool) => {
+    return Boolean(env[ciTool]);
+};
+//# sourceMappingURL=is-ci-tool-detected.js.map

package/dist/is-ci-tool-detected.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-ci-tool-detected.js","sourceRoot":"","sources":["../src/is-ci-tool-detected.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAsB,EAAE,MAAc,EAAW,EAAE;IAClF,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;AAC9B,CAAC,CAAC"}

package/dist/is-usable-ci-environment.d.ts

@@ -0,0 +1,10 @@
+import type { Context } from "@release-change/shared";
+/**
+ * Checks whether the CI environment is usable for the run to proceed.
+ * A usable CI environment does not provide any context when the run is triggered by a pull request.
+ * An unknown CI environment does not prevent the run from proceeding but activates the dry-run mode.
+ * @param context - The context where the CLI is running.
+ * @return `true` if the CI environment is usable, `false` otherwise.
+ */
+export declare const isUsableCiEnvironment: (context: Context) => boolean;
+//# sourceMappingURL=is-usable-ci-environment.d.ts.map

package/dist/is-usable-ci-environment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-usable-ci-environment.d.ts","sourceRoot":"","sources":["../src/is-usable-ci-environment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAMtD;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAAI,SAAS,OAAO,KAAG,OAsBxD,CAAC"}

package/dist/is-usable-ci-environment.js

@@ -0,0 +1,29 @@
+import { inspect } from "node:util";
+import { setLogger } from "@release-change/logger";
+/**
+ * Checks whether the CI environment is usable for the run to proceed.
+ * A usable CI environment does not provide any context when the run is triggered by a pull request.
+ * An unknown CI environment does not prevent the run from proceeding but activates the dry-run mode.
+ * @param context - The context where the CLI is running.
+ * @return `true` if the CI environment is usable, `false` otherwise.
+ */
+export const isUsableCiEnvironment = (context) => {
+    const { config, ci } = context;
+    const { isCi, isPullRequest } = ci;
+    const logger = setLogger(config.debug);
+    logger.setScope("ci");
+    if (config.debug) {
+        logger.setDebugScope("ci:is-usable-ci-environment");
+        logger.logDebug(inspect(ci, { depth: Number.POSITIVE_INFINITY }));
+    }
+    if (isCi && isPullRequest) {
+        logger.logWarn("This run is triggered by a pull request; therefore, a new version will not be published.");
+        return false;
+    }
+    if (!isCi) {
+        config.dryRun = true;
+        logger.logWarn("This run is not triggered in a known CI environment; therefore, the dry-run mode is enabled.");
+    }
+    return true;
+};
+//# sourceMappingURL=is-usable-ci-environment.js.map

package/dist/is-usable-ci-environment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-usable-ci-environment.js","sourceRoot":"","sources":["../src/is-usable-ci-environment.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAAgB,EAAW,EAAE;IACjE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC;IAC/B,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC;IACnC,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACtB,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,MAAM,CAAC,aAAa,CAAC,6BAA6B,CAAC,CAAC;QACpD,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,IAAI,IAAI,aAAa,EAAE,CAAC;QAC1B,MAAM,CAAC,OAAO,CACZ,0FAA0F,CAC3F,CAAC;QACF,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;QACrB,MAAM,CAAC,OAAO,CACZ,8FAA8F,CAC/F,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@release-change/ci",
+  "version": "0.1.0",
+  "description": "Get environment variables related to the CI",
+  "keywords": [],
+  "homepage": "https://github.com/release-change/release-change",
+  "bugs": {
+    "url": "https://github.com/release-change/release-change/issues"
+  },
+  "author": "Victor Brito (https://victor-brito.dev)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/release-change/release-change.git"
+  },
+  "type": "module",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    "import": "./dist/index.js",
+    "types": "./dist/index.d.ts"
+  },
+  "engines": {
+    "node": "^20.18.3 || ^22.12.0 || ^24.0.0",
+    "npm": ">=10.8.2",
+    "pnpm": ">=10.28.0"
+  },
+  "dependencies": {
+    "@release-change/logger": "0.1.0",
+    "@release-change/shared": "0.1.0",
+    "@release-change/config": "0.1.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch --preserveWatchOutput & vitest"
+  }
+}