cross-ci

v1.7.0

`cross-ci` standardizes environment variables for CI. For example, your can simply use `BUILD_BRANCH` variable in all CI runners instead of `CIRCLE_BRANCH` in CircleCI or `TRAVIS_PULL_REQUEST_BRANCH` in Travis. For more information about how to use this package see README

Latest version published 1 year ago

License: Unlicense

NPM

GitHub

Package Health Score

46 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Limited

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

All Versions

Version				Vulnerabilities	License Risk
1.7.0	\|	05/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.6.0	\|	02/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.1	\|	05/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.1	\|	05/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Unlicense

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

Limited

Weekly Downloads (852)

GitHub Stars: 14
Forks: 1
Contributors: -

Direct Usage Popularity

The npm package cross-ci receives a total of 852 downloads a week. As such, we scored cross-ci popularity level to be Limited.

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

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

Community

Limited

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

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like cross-ci is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 2
Open PR: 7
Last Release: 1 year ago
Last Commit: 1 year ago

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

An important project maintenance signal to consider for cross-ci is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

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: not defined

Age: 6 years
Dependencies: 1 Direct
Versions: 14
Install Size: 45.1 kB
Dist-tags: 1
# of Files: 94
Maintainers: 1
TS Typings: No

cross-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.

Readme

cross-ci

cross-ci standardizes environment variables for CI. For example, your can simply use BUILD_BRANCH variable in all CI runners instead of CIRCLE_BRANCH in CircleCI or TRAVIS_PULL_REQUEST_BRANCH in Travis.

Install

npm i cross-ci

Node usage

const vars = require('cross-ci').vars;

CLI usage

npx cross-ci printenv BUILD_COMMIT_URL

Variables

Pseudo Commands

`:echo`

npx cross-ci :echo node --eval "\"console.log('\${PROJECT_NAME}')\""

`:run`

npx cross-ci :run node --eval "\"console.log('\${PROJECT_NAME}')\""

Examples

Provide Evn Vars to Webpack, from `package.json`

{
    "scripts": {
        "build": "cross-ci webpack -p"
    }
}

Update GitHub status

npx cross-ci :run \
    npx commit-status success Storybook "'\${BUILD_VERSION}'" "'https://example.com'"

Upload to S3

npx cross-ci :run \
    s3 sync ./public "s3://bucket/builds/\${PROJECT_NAME}/\${BUILD_VERSION}/public" \
        --region eu-west-1 \
        --acl public-read

Post to Slack

npx cross-ci :run \
    curl -X POST -H 'Content-type: application/json' \
        --data "'{\
            \"text\":\"Built \\\`&lt;\${PROJECT_URL}|\${PROJECT_NAME}&gt;\\\` :crossed_fingers: \\\`&lt;\${BRANCH_URL}|\${BUILD_BRANCH}&gt;\\\` :crossed_fingers: \\\`\${BUILD_VERSION}\\\` on &lt;\${BUILD_URL}|\${CI_NAME}&gt; :tada:\", \
            \"username\": \"cross-ci\", \
            \"icon_emoji\": \":clap:\"}'" \
        https://hooks.slack.com/services/XXXX/XXXX/XXXXXXXX

Post to GitHub

GITHUB_TOKEN=XXXXXXXX \
    npx cross-ci :run \
        curl -X POST -H "Content-Type: application/json" \
            --data "'{\"body\": \"Build version: \\\`\${BUILD_VERSION}\\\` :crossed_fingers: [\\\`\${BUILD_BRANCH}\\\`](\${BRANCH_URL}) on [\${CI_NAME}](\${BUILD_URL}) :tada:\"}'" \
        "https://api.github.com/repos/\${PROJECT_OWNER}/\${PROJECT_NAME}/issues/\${BUILD_PR_NUM}/comments?access_token=\${GITHUB_TOKEN}"

Variable Reference

`BUILD_BRANCH`

Git branch being built or targeted by a pull request.

`BUILD_COMMIT_PR_URL`

URL of PR build commit.

`BUILD_COMMIT_URL`

URL of build commit.

`BUILD_COMMIT`

SHA1 of the Git commit being built.

`BUILD_COMMIT7`

First 7 chars of SHA1 of the Git commit being built.

`BUILD_DIR`

Path to repository folder.

`BUILD_NUM`

CI service build number.

`BUILD_PR_NUM`

Pull request (aka Merge request) number. Defaults to 0.

`BUILD_PR_URL`

URL to GitHub PR page.

`BUILD_URL`

URL to CI build page.

`BUILD_VERSION`

A human-readable string uniquely identifying current build. For pull requests will equal to something like x.y.z-pr-1.1. For build jobs that are not part of a pull request, it will contain a branch name, like x.y.z-master.1.

`CI_NAME`

CI service Commercial name (e.g. Travis, CircleCI, TeamCity).

`CI_PLATFORM`

Standardized CI service name (e.g. travis, circle, gitlab).

`GIT_PLATFORM`

Git version control system used

`GIT_REMOTE`

Git remote used.

`GITHUB_TOKEN`

Equals to GITHUB_TOKEN, GITHUB_ACCESS_TOKEN, GH_TOKEN, or GIT_CREDENTIALS environment variables, in that order.

`IS_CI`

Boolean indicating if script runs in a CI environment.

`IS_PR`

Boolean, true if the current build is triggered by a pull request.

`IS_RELEASE`

Is true if currently built branch is one of RELEASE_BRANCHES.

`JOB_NUM`

CI service job number

`JOB_URL`

Link to the CI service job

`MONTH`

Current month numeric value as a string of length two.

`PROJECT_NAME`

GitHub project name.

`PROJECT_OWNER`

User name or organization name that owns the repository.

`PROJECT_URL`

Link to project on GitHub.

`PROJECT_VERSION`

Semver version of your project. Taken from package.json. Othewise defaults to 0.0.0.

`RELEASE_BRANCHES`

Names of branches which should trigger a release, defaults to ['master', 'production'].

`TIME`

Current time in UTC format.

`TIMESTAMP`

UNIX timestamp.

`UPLOAD_PATH`

Relative upload path for artifacts. Defaults to:

builds/${PROJECT_NAME}/${BUILD_VERSION}

`YEAR`

Current year as a four character long string.

cross-ci dependencies

env-ci

cross-ci development dependencies

glob mmarkdown eslint eslint-config-mailonline mol-conventional-changelog jest husky

FAQs

What is cross-ci?

`cross-ci` standardizes environment variables for CI. For example, your can simply use `BUILD_BRANCH` variable in all C... Visit Snyk Advisor to see a full health score report for cross-ci, including popularity, security, maintenance & community analysis.

Is cross-ci popular?

The npm package cross-ci receives a total of 852 weekly downloads. As such, cross-ci popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is cross-ci well maintained?

We found indications that cross-ci is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is cross-ci safe to use?

The npm package cross-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 30 October-2024, at 22:38 (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

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (852)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

cross-ci

Install

Node usage

CLI usage

Variables

Pseudo Commands

:echo

:run

Examples

Provide Evn Vars to Webpack, from package.json

Update GitHub status

Upload to S3

Post to Slack

Post to GitHub

Variable Reference

BUILD_BRANCH

BUILD_COMMIT_PR_URL

BUILD_COMMIT_URL

BUILD_COMMIT

BUILD_COMMIT7

BUILD_DIR

BUILD_NUM

BUILD_PR_NUM

BUILD_PR_URL

BUILD_URL

BUILD_VERSION

CI_NAME

CI_PLATFORM

GIT_PLATFORM

GIT_REMOTE

GITHUB_TOKEN

IS_CI

IS_PR

IS_RELEASE

JOB_NUM

JOB_URL

MONTH

PROJECT_NAME

PROJECT_OWNER

PROJECT_URL

PROJECT_VERSION

RELEASE_BRANCHES

TIME

TIMESTAMP

UPLOAD_PATH

YEAR

cross-ci dependencies

cross-ci development dependencies

FAQs

What is cross-ci?

Is cross-ci popular?

Is cross-ci well maintained?

Is cross-ci safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

`:echo`

`:run`

Provide Evn Vars to Webpack, from `package.json`

`BUILD_BRANCH`

`BUILD_COMMIT_PR_URL`

`BUILD_COMMIT_URL`

`BUILD_COMMIT`

`BUILD_COMMIT7`

`BUILD_DIR`

`BUILD_NUM`

`BUILD_PR_NUM`

`BUILD_PR_URL`

`BUILD_URL`

`BUILD_VERSION`

`CI_NAME`

`CI_PLATFORM`

`GIT_PLATFORM`

`GIT_REMOTE`

`GITHUB_TOKEN`

`IS_CI`

`IS_PR`

`IS_RELEASE`

`JOB_NUM`

`JOB_URL`

`MONTH`

`PROJECT_NAME`

`PROJECT_OWNER`

`PROJECT_URL`

`PROJECT_VERSION`

`RELEASE_BRANCHES`

`TIME`

`TIMESTAMP`

`UPLOAD_PATH`

`YEAR`