env-ci - npm Package Compare versions

Comparing version 2.4.0 to 2.5.0

lib/appveyor.js

@@ -12,2 +12,3 @@ // https://www.appveyor.com/docs/environment-variables
 			commit: env.APPVEYOR_REPO_COMMIT,
+			tag: env.APPVEYOR_REPO_TAG_NAME,
 			build: env.APPVEYOR_BUILD_NUMBER,
@@ -14,0 +15,0 @@ buildUrl: `https://ci.appveyor.com/project/${env.APPVEYOR_PROJECT_SLUG}/build/${env.APPVEYOR_BUILD_VERSION}`,

lib/bitbucket.js

@@ -12,2 +12,3 @@ // https://confluence.atlassian.com/bitbucket/environment-variables-794502608.html
 			commit: env.BITBUCKET_COMMIT,
+			tag: env.BITBUCKET_TAG,
 			build: env.BITBUCKET_BUILD_NUMBER,
@@ -14,0 +15,0 @@ buildUrl: `https://bitbucket.org/${env.BITBUCKET_REPO_SLUG}/addon/pipelines/home#!/results/${

lib/bitrise.js

@@ -1,2 +0,2 @@
-// http://devcenter.bitrise.io/faq/available-environment-variables
+// https://devcenter.bitrise.io/builds/available-environment-variables/#exposed-by-bitriseio
 
@@ -12,2 +12,3 @@ module.exports = {
 			commit: env.BITRISE_GIT_COMMIT,
+			tag: env.BITRISE_GIT_TAG,
 			build: env.BITRISE_BUILD_NUMBER,
@@ -14,0 +15,0 @@ buildUrl: env.BITRISE_BUILD_URL,

lib/buddy.js

@@ -12,2 +12,3 @@ // https://buddy.works/knowledge/deployments/how-use-environment-variables#default-environment-variables
 			commit: env.BUDDY_EXECUTION_REVISION,
+			tag: env.BUDDY_EXECUTION_TAG,
 			build: env.BUDDY_EXECUTION_ID,
@@ -14,0 +15,0 @@ buildUrl: env.BUDDY_EXECUTION_URL,

lib/buildkite.js

@@ -14,2 +14,3 @@ // https://buildkite.com/docs/builds/environment-variables
 			commit: env.BUILDKITE_COMMIT,
+			tag: env.BUILDKITE_TAG,
 			branch: env.BUILDKITE_BRANCH,
@@ -16,0 +17,0 @@ slug: `${env.BUILDKITE_ORGANIZATION_SLUG}/${env.BUILDKITE_PROJECT_SLUG}`,

lib/circleci.js

@@ -1,3 +0,2 @@
-// Circle 1.0 docs: https://circleci.com/docs/1.0/environment-variables
-// Circle 2.0 docs: https://circleci.com/docs/2.0/env-vars/
+// Circle 2.0 docs: https://circleci.com/docs/2.0/env-vars/#built-in-environment-variables
 
@@ -19,2 +18,3 @@ module.exports = {
 			commit: env.CIRCLE_SHA1,
+			tag: env.CIRCLE_TAG,
 			branch: env.CIRCLE_BRANCH,
@@ -21,0 +21,0 @@ pr: pullRequest,

lib/cirrus.js

@@ -14,2 +14,3 @@ // https://cirrus-ci.org/guide/writing-tasks/#environment-variables
 			commit: env.CIRRUS_CHANGE_IN_REPO,
+			tag: env.CIRRUS_TAG,
 			build: env.CIRRUS_BUILD_ID,
@@ -16,0 +17,0 @@ buildUrl: `${CIRRUS_CI_DASHBOARD}/build/${env.CIRRUS_BUILD_ID}`,

lib/codeship.js

@@ -1,2 +0,2 @@
-// https://documentation.codeship.com/basic/builds-and-configuration/set-environment-variables
+// https://documentation.codeship.com/basic/builds-and-configuration/set-environment-variables/#default-environment-variables
 
@@ -3,0 +3,0 @@ module.exports = {

lib/drone.js

@@ -1,2 +0,2 @@
-// http://readme.drone.io/0.5/usage/environment-reference
+// https://readme.drone.io/reference/environ
 
@@ -12,2 +12,3 @@ module.exports = {
 			commit: env.DRONE_COMMIT_SHA,
+			tag: env.DRONE_TAG,
 			build: env.DRONE_BUILD_NUMBER,
@@ -14,0 +15,0 @@ branch: env.DRONE_BRANCH,

lib/gitlab.js

@@ -12,2 +12,3 @@ // https://docs.gitlab.com/ce/ci/variables/README.html
 			commit: env.CI_COMMIT_SHA,
+			tag: env.CI_COMMIT_TAG,
 			build: env.CI_PIPELINE_ID,
@@ -14,0 +15,0 @@ buildUrl: `${env.CI_PROJECT_URL}/pipelines/${env.CI_PIPELINE_ID}`,

lib/shippable.js

@@ -12,2 +12,3 @@ // http://docs.shippable.com/ci/env-vars/#stdEnv
 			commit: env.COMMIT,
+			tag: env.GIT_TAG_NAME,
 			build: env.BUILD_NUMBER,
@@ -14,0 +15,0 @@ buildUrl: env.BUILD_URL,

lib/travis.js

@@ -1,2 +0,2 @@
-// https://docs.travis-ci.com/user/environment-variables
+// https://docs.travis-ci.com/user/environment-variables#default-environment-variables
 
@@ -12,2 +12,3 @@ module.exports = {
 			commit: env.TRAVIS_COMMIT,
+			tag: env.TRAVIS_TAG,
 			build: env.TRAVIS_BUILD_NUMBER,
@@ -14,0 +15,0 @@ branch: env.TRAVIS_BRANCH,

package.json

 {
   "name": "env-ci",
   "description": "Get environment variables exposed by CI services",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "author": "Pierre Vanduynslager (https://github.com/pvdlg)",
@@ -6,0 +6,0 @@ "bugs": {

README.md

@@ -22,3 +22,3 @@ # env-ci
 
-const {isCi, name, service, commit, build, buildUrl, branch, job, jobUrl, pr, isPr, slug, root} = envCi();
+const {name, service, isCi, branch, commit, tag, build, buildUrl, job, jobUrl, isPr, pr, slug, root} = envCi();
 
@@ -42,14 +42,15 @@ if (isCI) {
 |------------|-----------------------------------------------------------------------------------|
-| `isCi`     | `true` is running on a CI, `false` otherwise                                      |
 | `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                                                      |
-| `branch`   | Git branch being built or targeted by a pull request                              |
 | `job`      | CI service job number                                                             |
 | `jobUrl`   | Link to the CI service job                                                        |
+| `isPr`     | `true` is the build has been triggered by a Pull Request, `false` otherwise       |
 | `pr`       | Pull Request number                                                               |
-| `isPr`     | `true` is the build has been triggered by a Pull Request, `false` otherwise       |
-| `slug`     | The slug (in form: owner_name/repo_name) of the repository currently being built. |
+| `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                     |
@@ -61,23 +62,23 @@
 
-| CI Service (`name`)                                                                                            |  `service`  | `isCi` | `commit` | `build` | `buildUrl` | `branch` | `job` | `jobUrl` | `pr` | `isPr` | `slug` | `root` |
-|----------------------------------------------------------------------------------------------------------------|:-----------:|:------:|:--------:|:-------:|:----------:|:--------:|:-----:|:--------:|:----:|:------:|:------:|:------:|
-| [AppVeyor]( https://www.appveyor.com/docs/environment-variables)                                               | `appveyor`  |   ✅    |    ✅     |    ✅    |     ✅      |    ✅     |   ✅   |    ✅     |  ✅   |   ✅    |   ✅    |   ✅    |
-| [Bamboo](https://confluence.atlassian.com/bamboo/bamboo-variables-289277087.html)                              |  `bamboo`   |   ✅    |    ✅     |    ✅    |     ✅      |    ✅     |   ✅   |    ❌     |  ❌   |   ❌    |   ❌    |   ✅    |
-| [Bitbucket](https://confluence.atlassian.com/bitbucket/environment-variables-794502608.html)                   | `bitbucket` |   ✅    |    ✅     |    ✅    |     ✅      |    ✅     |   ❌   |    ❌     |  ❌   |   ❌    |   ✅    |   ✅    |
-| [Bitrise](http://devcenter.bitrise.io/faq/available-environment-variables/#exposed-by-bitriseio)               |  `bitrise`  |   ✅    |    ✅     |    ✅    |     ✅      |    ✅     |   ❌   |    ❌     |  ✅   |   ✅    |   ✅    |   ❌    |
-| [Buddy](https://buddy.works/knowledge/deployments/how-use-environment-variables#default-environment-variables) |   `buddy`   |   ✅    |    ✅     |    ✅    |     ✅      |    ✅     |   ❌   |    ❌     |  ✅   |   ✅    |   ✅    |   ❌    |
-| [Buildkite](https://buildkite.com/docs/builds/environment-variables)                                           | `buildkite` |   ✅    |    ✅     |    ✅    |     ✅      |    ✅     |   ❌   |    ❌     |  ✅   |   ✅    |   ✅    |   ✅    |
-| [CircleCI](https://circleci.com/docs/1.0/environment-variables)                                                | `circleci`  |   ✅    |    ✅     |    ✅    |     ✅      |    ✅     |   ✅   |    ❌     |  ✅   |   ✅    |   ✅    |   ❌    |
-| [Cirrus CI](https://cirrus-ci.org/guide/writing-tasks/#environment-variables)                                  |  `cirrus`   |   ✅    |    ✅     |    ✅    |     ✅      |    ✅     |   ✅   |    ✅     |  ✅   |   ✅    |   ✅    |   ✅    |
-| [AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html)            | `codebuild` |   ✅    |    ✅     |    ✅    |     ✅      |    ✅     |   ❌   |    ❌     |  ❌   |   ❌    |   ❌    |   ✅    |
-| [Codeship](https://documentation.codeship.com/basic/builds-and-configuration/set-environment-variables)        | `codeship`  |   ✅    |    ✅     |    ✅    |     ✅      |    ✅     |   ❌   |    ❌     |  ❌   |   ❌    |   ✅    |   ❌    |
-| [Drone](http://readme.drone.io/0.5/usage/environment-reference)                                                |   `drone`   |   ✅    |    ✅     |    ✅    |     ❌      |    ✅     |   ✅   |    ❌     |  ✅   |   ✅    |   ✅    |   ❌    |
-| [Gitlab CI/CD](https://docs.gitlab.com/ce/ci/variables/README.html)                                            |  `gitlab`   |   ✅    |    ✅     |    ✅    |     ✅      |    ✅     |   ✅   |    ✅     |  ❌   |   ❌    |   ✅    |   ✅    |
-| [Jenkins](https://wiki.jenkins.io/display/JENKINS/Building+a+software+project)                                 |  `jenkins`  |   ✅    |    ✅     |    ✅    |     ✅      |    ✅     |   ❌   |    ❌     |  ❌   |   ❌    |   ✅    |   ✅    |
-| [Semaphore](https://semaphoreci.com/docs/available-environment-variables.html)                                 | `semaphore` |   ✅    |    ✅     |    ✅    |     ❌      |    ✅     |   ✅   |    ❌     |  ✅   |   ✅    |   ✅    |   ✅    |
-| [Shippable](http://docs.shippable.com/ci/env-vars/#stdEnv)                                                     | `shippable` |   ✅    |    ✅     |    ✅    |     ✅      |    ✅     |   ✅   |    ❌     |  ✅   |   ✅    |   ✅    |   ✅    |
-| [TeamCity](https://confluence.jetbrains.com/display/TCD10/Predefined+Build+Parameters)                         | `teamcity`  |   ✅    |    ✅     |    ✅    |     ❌      |    ✅     |   ❌   |    ❌     |  ❌   |   ❌    |   ✅    |   ✅    |
-| [Travis CI](https://docs.travis-ci.com/user/environment-variables)                                             |  `travis`   |   ✅    |    ✅     |    ✅    |     ❌      |    ✅     |   ✅   |    ❌     |  ✅   |   ✅    |   ✅    |   ✅    |
-| [Visual Studio Team Services](https://docs.microsoft.com/en-us/vsts/pipelines/build/variables)                 |   `vsts`    |   ✅    |    ✅     |    ✅    |     ❌      |    ✅     |   ❌   |    ❌     |  ✅   |   ✅    |   ❌    |   ✅    |
-| [Wercker](http://devcenter.wercker.com/docs/environment-variables/available-env-vars#hs_cos_wrapper_name)      |  `wercker`  |   ✅    |    ✅     |    ✅    |     ✅      |    ✅     |   ❌   |    ❌     |  ❌   |   ❌    |   ✅    |   ✅    |
+| CI Service (`name`)                                                                                                                    |  `service`  | `isCi` | `branch` | `commit` | `tag` | `build` | `buildUrl` | `job` | `jobUrl` | `isPr` | `pr` | `slug` | `root` |
+|----------------------------------------------------------------------------------------------------------------------------------------|:-----------:|:------:|:--------:|:--------:|:-----:|:-------:|:----------:|:-----:|:--------:|:------:|:----:|:------:|:------:|
+| [AppVeyor]( https://www.appveyor.com/docs/environment-variables)                                                                       | `appveyor`  |   ✅    |    ✅     |    ✅     |   ✅   |    ✅    |     ✅      |   ✅   |    ✅     |   ✅    |  ✅   |   ✅    |   ✅    |
+| [Bamboo](https://confluence.atlassian.com/bamboo/bamboo-variables-289277087.html)                                                      |  `bamboo`   |   ✅    |    ✅     |    ✅     |   ❌   |    ✅    |     ✅      |   ✅   |    ❌     |   ❌    |  ❌   |   ❌    |   ✅    |
+| [Bitbucket](https://confluence.atlassian.com/bitbucket/environment-variables-794502608.html)                                           | `bitbucket` |   ✅    |    ✅     |    ✅     |   ✅   |    ✅    |     ✅      |   ❌   |    ❌     |   ❌    |  ❌   |   ✅    |   ✅    |
+| [Bitrise](https://devcenter.bitrise.io/builds/available-environment-variables/#exposed-by-bitriseio)                                   |  `bitrise`  |   ✅    |    ✅     |    ✅     |   ✅   |    ✅    |     ✅      |   ❌   |    ❌     |   ✅    |  ✅   |   ✅    |   ❌    |
+| [Buddy](https://buddy.works/knowledge/deployments/how-use-environment-variables#default-environment-variables)                         |   `buddy`   |   ✅    |    ✅     |    ✅     |   ✅   |    ✅    |     ✅      |   ❌   |    ❌     |   ✅    |  ✅   |   ✅    |   ❌    |
+| [Buildkite](https://buildkite.com/docs/builds/environment-variables)                                                                   | `buildkite` |   ✅    |    ✅     |    ✅     |   ✅   |    ✅    |     ✅      |   ❌   |    ❌     |   ✅    |  ✅   |   ✅    |   ✅    |
+| [CircleCI](https://circleci.com/docs/2.0/env-vars/#built-in-environment-variables)                                                     | `circleci`  |   ✅    |    ✅     |    ✅     |   ✅   |    ✅    |     ✅      |   ✅   |    ❌     |   ✅    |  ✅   |   ✅    |   ❌    |
+| [Cirrus CI](https://cirrus-ci.org/guide/writing-tasks/#environment-variables)                                                          |  `cirrus`   |   ✅    |    ✅     |    ✅     |   ✅   |    ✅    |     ✅      |   ✅   |    ✅     |   ✅    |  ✅   |   ✅    |   ✅    |
+| [AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html)                                    | `codebuild` |   ✅    |    ✅     |    ✅     |   ❌   |    ✅    |     ✅      |   ❌   |    ❌     |   ❌    |  ❌   |   ❌    |   ✅    |
+| [Codeship](https://documentation.codeship.com/basic/builds-and-configuration/set-environment-variables/#default-environment-variables) | `codeship`  |   ✅    |    ✅     |    ✅     |   ✅   |    ✅    |     ✅      |   ❌   |    ❌     |   ❌    |  ❌   |   ✅    |   ❌    |
+| [Drone](https://readme.drone.io/reference/environ/)                                                                                    |   `drone`   |   ✅    |    ✅     |    ✅     |   ✅   |    ✅    |     ❌      |   ✅   |    ❌     |   ✅    |  ✅   |   ✅    |   ❌    |
+| [Gitlab CI/CD](https://docs.gitlab.com/ce/ci/variables/README.html)                                                                    |  `gitlab`   |   ✅    |    ✅     |    ✅     |   ✅   |    ✅    |     ✅      |   ✅   |    ✅     |   ❌    |  ❌   |   ✅    |   ✅    |
+| [Jenkins](https://wiki.jenkins.io/display/JENKINS/Building+a+software+project)                                                         |  `jenkins`  |   ✅    |    ✅     |    ✅     |   ❌   |    ✅    |     ✅      |   ❌   |    ❌     |   ❌    |  ❌   |   ✅    |   ✅    |
+| [Semaphore](https://semaphoreci.com/docs/available-environment-variables.html)                                                         | `semaphore` |   ✅    |    ✅     |    ✅     |   ❌   |    ✅    |     ❌      |   ✅   |    ❌     |   ✅    |  ✅   |   ✅    |   ✅    |
+| [Shippable](http://docs.shippable.com/ci/env-vars/#stdEnv)                                                                             | `shippable` |   ✅    |    ✅     |    ✅     |   ✅   |    ✅    |     ✅      |   ✅   |    ❌     |   ✅    |  ✅   |   ✅    |   ✅    |
+| [TeamCity](https://confluence.jetbrains.com/display/TCD10/Predefined+Build+Parameters)                                                 | `teamcity`  |   ✅    |    ✅     |    ✅     |   ❌   |    ✅    |     ❌      |   ❌   |    ❌     |   ❌    |  ❌   |   ✅    |   ✅    |
+| [Travis CI](https://docs.travis-ci.com/user/environment-variables#default-environment-variables)                                       |  `travis`   |   ✅    |    ✅     |    ✅     |   ✅   |    ✅    |     ❌      |   ✅   |    ❌     |   ✅    |  ✅   |   ✅    |   ✅    |
+| [Visual Studio Team Services](https://docs.microsoft.com/en-us/vsts/pipelines/build/variables)                                         |   `vsts`    |   ✅    |    ✅     |    ✅     |   ❌   |    ✅    |     ❌      |   ❌   |    ❌     |   ✅    |  ✅   |   ❌    |   ✅    |
+| [Wercker](http://devcenter.wercker.com/docs/environment-variables/available-env-vars#hs_cos_wrapper_name)                              |  `wercker`  |   ✅    |    ✅     |    ✅     |   ❌   |    ✅    |     ✅      |   ❌   |    ❌     |   ❌    |  ❌   |   ✅    |   ✅    |
 
@@ -84,0 +85,0 @@ **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.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

26738

increased by4.48%

Lines of code

462

increased by2.21%

Number of lines in readme file

125

increased by0.81%

No dependency changes