Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitac2e65b

Browse files
committed
docs: update readme
1 parentc6d1d7a commitac2e65b

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

‎README.md‎

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ npx cross-ci printenv BUILD_COMMIT_URL
4040
-[`IS_CI`](#is_ci)
4141
-[`IS_PR`](#is_pr)
4242
-[`IS_RELEASE`](#is_release)
43+
-[`JOB_NUM`](#job_num)
44+
-[`JOB_URL`](#job_url)
4345
-[`MONTH`](#month)
4446
-[`PROJECT_NAME`](#project_name)
4547
-[`PROJECT_OWNER`](#project_owner)
@@ -137,12 +139,16 @@ SHA1 of the Git commit being built.
137139

138140
####`BUILD_DIR`
139141

142+
143+
140144
Path to repository folder.
141145

142146

143147

144148
####`BUILD_NUM`
145149

150+
151+
146152
Build number, a numeric value uniquely identifying current build.
147153
In CircleCI equals to`CIRCLE_BUILD_NUM` environment variable.
148154
In TravisCI equals to`TRAVIS_BUILD_NUMBER` environment variable.
@@ -154,7 +160,9 @@ If not build number detected, defaults to `0`.
154160

155161
####`BUILD_PR_NUM`
156162

157-
Number of the pull request on GitHub.
163+
164+
165+
Number of the pull request on Git platform.
158166
In CircleCI pull request number is extracted from`CI_PULL_REQUEST` environment variable.
159167
Which is a link to the pull request of the current job.
160168
In TravicCI`TRAVIS_PULL_REQUEST` environment varialbe is used.
@@ -173,6 +181,8 @@ URL to GitHub PR page.
173181

174182
####`BUILD_URL`
175183

184+
185+
176186
URL to CI build page.
177187

178188

@@ -188,21 +198,27 @@ it will contain a branch name, like `x.y.z-master.1`.
188198

189199
####`CI_NAME`
190200

201+
202+
191203
A user-friendly CI display name.
192204

193205
-`CircleCI` for CircleCI
194206
-`Travis` for TravisCI
195207
-`TeamCity` for TeamCity
208+
-`Gitlab` for Gitlab
196209

197210

198211

199212
####`CI_PLATFORM`
200213

214+
215+
201216
A string identifying the CI platform.
202217

203218
-`circle` for CircleCI
204219
-`travis` for TravisCI
205220
-`teamcity` for TeamCity
221+
-`gitlab` for Gitlab
206222

207223

208224

@@ -214,12 +230,16 @@ Equals to `GITHUB_TOKEN` or `GITHUB_ACCESS_TOKEN` environment variables, in that
214230

215231
####`IS_CI`
216232

233+
234+
217235
Boolean indicating if script runs in a CI environment.
218236

219237

220238

221239
####`IS_PR`
222240

241+
242+
223243
Boolean,`true` if the current build is triggered by a pull request.
224244

225245

@@ -230,6 +250,18 @@ Is `true` if currently built branch is one of `RELEASE_BRANCHES`.
230250

231251

232252

253+
####`JOB_NUM`
254+
255+
CI service job number
256+
257+
258+
259+
####`JOB_URL`
260+
261+
Link to the CI service job
262+
263+
264+
233265
####`MONTH`
234266

235267
Current month numeric value as a string of length two.
@@ -273,7 +305,8 @@ Link to project on GitHub.
273305

274306
####`PROJECT_VERSION`
275307

276-
Semver version of your project. Taken from`package.json`.
308+
Semver version of your project. Taken from`package.json`. Othewise
309+
defaults to`0.0.0`.
277310

278311

279312

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp