Package Health Score

89 / 100

security
No known security issues
popularity
Influential project
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
11.1.0	\|	08/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
11.0.0	\|	12/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
10.0.0	\|	09/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
9.1.1	\|	06/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.5.0	\|	12/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Influential project

Weekly Downloads (1,413,424)

GitHub Stars: 230
Forks: 47
Contributors: 30

Direct Usage Popularity

The npm package env-ci receives a total of 1,413,424 downloads a week. As such, we scored env-ci popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package env-ci, we found that it has been starred 230 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 30
Funding: No

With more than 10 contributors for the env-ci repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 5
Open PR: 7
Last Release: 4 months ago
Last Commit: 6 days ago

Further analysis of the maintenance status of env-ci based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that env-ci demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: ^18.17 || >=20.6.1

Age: 7 years
Dependencies: 2 Direct
Versions: 80
Install Size: 53.4 kB
Dist-tags: 2
# of Files: 38
Maintainers: 4
TS Typings: Yes

env-ci has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use env-ci?

To help you get started, we've collected the most common ways that env-ci is being used within popular public projects.

apollographql / apollo-tooling / packages / apollo / src / commands / service / check.ts View on Github

async run() {
    // @ts-ignore we're going to populate `taskOutput` later
    const taskOutput: TasksOutput = {};

    // Define this constant so we can throw it and compare against the same value.
    const breakingChangesErrorMessage = "breaking changes found";
    const federatedServiceCompositionUnsuccessfulErrorMessage =
      "Federated service composition was unsuccessful. Please see the reasons below.";

    const { isCi } = envCi();

    let schema: GraphQLSchema | undefined;
    let graphID: string | undefined;
    let graphVariant: string | undefined;
    try {
      await this.runTasks(
        ({ config, flags, project }) =&gt; {
          /**
           * Name of the graph being checked. `engine` is an example of a graph.
           *
           * A graph can be either a monolithic schema or the result of composition a federated schema.
           */
          graphID = config.name;
          graphVariant = flags.tag || config.tag || "current";

          /**

View more ways to use env-ci

env-ci

Get environment variables exposed by CI services.

Adapted from codecov-node.

Install

$ npm install --save env-ci

Usage

import envCi from "env-ci";

const {
  name,
  service,
  isCi,
  branch,
  commit,
  tag,
  build,
  buildUrl,
  job,
  jobUrl,
  isPr,
  pr,
  prBranch,
  slug,
  root,
} = envCi();

if (isCI) {
  console.log(`Building repo ${slug} on ${name} service`);

  if (isPr) {
    console.log(
      `Building Pull Request #${pr} originating from branch ${prBranch} and targeting branch ${branch}`,
    );
  } else {
    console.log(`Building branch ${branch}`);
  }

  if (service === "travis") {
    // Do something specific to Travis CI
  }
}

Supported variables

Variable	Description
`name`	CI service Commercial name (e.g. `Travis CI`, `CircleCI`, `GitLab CI/CD`)
`service`	Standardized CI service name (e.g. `travis`, `circleci`, `gitlab`)
`isCi`	`true` is running on a CI, `false` otherwise
`branch`	Git branch being built or targeted by a Pull Request
`commit`	Commit sha that triggered the CI build
`tag`	Git tag that triggered the CI build
`build`	CI service build number
`buildUrl`	Link to the CI service build
`job`	CI service job number
`jobUrl`	Link to the CI service job
`isPr`	`true` if the build has been triggered by a Pull Request, `false` otherwise
`pr`	Pull Request number (only for builds triggered by a Pull Request)
`prBranch`	Git branch branch from which the Pull Request originated (only for builds triggered by a Pull Request)
`slug`	The slug (in form: owner_name/repo_name) of the repository currently being built
`root`	The path to the directory where the repository is being built

Note: Some variables can be detected only on certain CI services. See Supported CI.

Note: The pr and prBranch properties are only available for builds triggered when a Pull Request is opened/updated and not on builds triggered by a push on a branch even if that branch happens to be the branch from which the Pull Request originated.

Supported CI

CI Service (`name`)	`service`	`isCi`	`branch`	`commit`	`tag`	`build`	`buildUrl`	`job`	`jobUrl`	`isPr`	`pr`	`prBranch`	`slug`	`root`
AppVeyor	`appveyor`	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
Azure Pipelines	`azure-devops`	✅	✅	✅	❌	✅	❌	❌	❌	✅	✅	✅	❌	✅
Bamboo	`bamboo`	✅	✅	✅	❌	✅	✅	✅	❌	❌	❌	❌	❌	✅
Bitbucket	`bitbucket`	✅	✅	✅	✅	✅	✅	❌	❌	❌	❌	❌	✅	✅
Bitrise	`bitrise`	✅	✅	✅	✅	✅	✅	❌	❌	✅	✅	✅	✅	❌
Buddy	`buddy`	✅	✅	✅	✅	✅	✅	❌	❌	✅	✅	❌	✅	❌
Buildkite	`buildkite`	✅	✅	✅	✅	✅	✅	❌	❌	✅	✅	✅	✅	✅
CircleCI	`circleci`	✅	⚠️	✅	✅	✅	✅	✅	❌	✅	✅	✅	✅	❌
Cirrus CI	`cirrus`	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
Cloudflare Pages	`cloudflarePages`	✅	✅	✅	❌	❌	❌	❌	❌	❌	❌	❌	❌	✅
AWS CodeBuild	`codebuild`	✅	⚠️	✅	❌	✅	✅	❌	❌	❌	❌	❌	❌	✅
Codefresh	`codefresh`	✅	✅	✅	❌	✅	✅	❌	❌	✅	✅	✅	✅	✅
Codeship	`codeship`	✅	✅	✅	✅	✅	✅	❌	❌	❌	❌	❌	✅	❌
Drone	`drone`	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
GitHub Actions	`github`	✅	✅	✅	❌	✅	❌	❌	❌	✅	✅	✅	✅	✅
GitLab CI/CD	`gitlab`	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
Jenkins	`jenkins`	✅	⚠️	✅	❌	✅	✅	❌	❌	⚠️	⚠️	⚠️	✅	✅
Netlify	`netlify`	✅	⚠️	✅	❌	✅	✅	❌	❌	✅	✅	✅	✅	✅
Puppet	`puppet`	✅	✅	✅	❌	✅	✅	❌	❌	❌	❌	❌	❌	✅
Sail CI	`sail`	✅	⚠️	✅	❌	❌	❌	❌	❌	✅	✅	❌	✅	✅
Screwdriver.cd	`screwdriver`	✅	⚠️	✅	❌	✅	✅	✅	❌	✅	✅	✅	✅	✅
Scrutinizer	`scrutinizer`	✅	✅	✅	❌	✅	❌	❌	❌	✅	✅	✅	❌	❌
Semaphore	`semaphore`	✅	⚠️	✅	⚠️	✅	❌	❌	❌	✅	✅	✅	✅	✅
Shippable	`shippable`	✅	✅	✅	✅	✅	✅	✅	❌	✅	✅	✅	✅	✅
TeamCity	`teamcity`	✅	✅	✅	❌	✅	❌	❌	❌	❌	❌	❌	✅	✅
Travis CI	`travis`	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
Vela	`vela`	✅	✅	✅	✅	✅	✅	❌	❌	✅	✅	✅	✅	✅
Vercel	`vercel`	✅	✅	✅	❌	❌	❌	❌	❌	❌	❌	❌	✅	❌
Wercker	`wercker`	✅	✅	✅	❌	✅	✅	❌	❌	❌	❌	❌	✅	✅
JetBrains Space	`jetbrainsSpace`	✅	✅	✅	❌	✅	❌	❌	❌	❌	❌	❌	✅	❌
Woodpecker CI	`woodpecker`	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅

⚠️ See Caveats

Note: Unsupported properties will always be undefined. For example if a Ci services doesn't support triggering builds when a Pull Request is opened/updated, isPr will be undefined.

Note: If none of the above CI services is detected, commit and branch are determined based on the local Git repository, and isCi is determined based on the CI environment variable.

API

envCi(options) => Result

options

Type: Object

env

Type: Object
Default: process.env

The object to read environment variables from.

cwd

Type: String
Default: process.cwd()

The current working directory in which to execute git commands used to determine the commit and branch Result properties in case no supported CI is detected.

Result

Type: Object

Environment variables values exposed by the CI service.

Caveats

AWS CodeBuild

AWS CodeBuild doesn't provide an environment variable to determine the current Git branch being built. In addition, it clones the repository in a detached head state so the branch cannot be determined with git rev-parse --abbrev-ref HEAD. To work around this limitation, env-ci look for the remote branches having the same HEAD as the local detached HEAD to determine the branch from which the detached HEAD was created. In the rare case where there is multiple remote branches with the same HEAD as the local detached HEAD, env-ci will arbitrarily pick the first one. This can lead to an inaccurate branch value in such circumstances.

CircleCI

For builds triggered when a Pull Request is opened/updated, CircleCI doesn't provide an environment variable indicating the target branch. Therefore, in the case of Pull Request builds, env-ci will not be able to determine the branch property. However prBranch will be set.

See feature request.

Cloudflare Pages

For builds triggered when a Pull Request is opened/updated, Cloudflare Pages will re-use the branch variable for the originating branch and not provide a target. Therefore env-ci will not be able to determine the prBranch property however branch will always be set.

Jenkins

Triggering build when a Pull Request is opened/updated is supported only via the ghprb-plugin and gitlab-plugin. Therefore env-ci will set isPr, pr and prBranch and define branch with the Pull Request target branch only if one those plugin is used.

Netlify

For builds triggered when a Pull Request is opened/updated, Netlify doesn't provide an environment variable indicating the target branch. Therefore, in the case of Pull Request builds, env-ci will not be able to determine the branch property. However prBranch will be set.

See feature request

Sail

For builds triggered when a Pull Request is opened/updated, Sail doesn't provide an environment variable indicating the target branch, and the one for the current branch is set to pull/ independently of the the branch name from which the Pull Request originated. Therefore, in the case of Pull Request builds, env-ci will not be able to determine the branch and prBranch properties.

Semaphore

For builds triggered when a Pull Request is opened/updated, Semaphore 1.0 doesn't provide an environment variable indicating the target branch. Therefore, in the case of Pull Request builds, env-ci will not be able to determine the branch property. However prBranch will be set. On Semaphore 2.0 the branch and prBranch properties will work as expected.

The property tag is only available on Semaphore 2.0.

Screwdriver

For builds triggered when a Pull Request is opened/updated, Screwdriver sets the env.GIT_BRANCH as head:pr branch type (Example:origin/refs/pull/1/head:pr) while at commit level (non PR) it does set it with the actual branch (Example: origin/main).

env-ci dependencies

execa java-properties

env-ci development dependencies

ava c8 file-url prettier tempy

FAQs

What is env-ci?

Get environment variables exposed by CI services. Visit Snyk Advisor to see a full health score report for env-ci, including popularity, security, maintenance & community analysis.

Is env-ci popular?

The npm package env-ci receives a total of 1,413,424 weekly downloads. As such, env-ci popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is env-ci well maintained?

We found that env-ci demonstrated a healthy version release cadence and project activity. It has a community of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is env-ci safe to use?

The npm package env-ci was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 01:00 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP