Skip to content

Commit

Permalink
[ci skip][ZKB-SYNC]: update contents
Browse files Browse the repository at this point in the history
  • Loading branch information
ganezasan committed Sep 20, 2022
1 parent fef8a65 commit fae75ed
Show file tree
Hide file tree
Showing 20 changed files with 87 additions and 34 deletions.
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
id: 360007188574
title: Build has hit timeout limit
title: Build has Hit Timeout Limit
author_id: 361269018513
created_at: '2018-07-19T16:41:05Z'
locale: en-us
permission_group_id: 237867
section_id: 7513289222427
user_segment_id: null
html_url: >-
https://support.circleci.com/hc/en-us/articles/360007188574-Build-has-hit-timeout-limit
https://support.circleci.com/hc/en-us/articles/360007188574-Build-has-Hit-Timeout-Limit
draft: false
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
id: 360052092532
title: Conditionally stop job when only change was to config.yml file
title: Conditionally Stop Job When Only Change Was to config.yml File
author_id: 405652843914
created_at: '2020-11-13T19:01:41Z'
locale: en-us
permission_group_id: 237867
section_id: 7513289222427
user_segment_id: null
html_url: >-
https://support.circleci.com/hc/en-us/articles/360052092532-Conditionally-stop-job-when-only-change-was-to-config-yml-file
https://support.circleci.com/hc/en-us/articles/360052092532-Conditionally-Stop-Job-When-Only-Change-Was-to-config-yml-File
draft: false
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
id: 360055901372
title: Auto-cancel re-run if newer commit exists
title: Auto-Cancel Re-Run if Newer Commit Exists
author_id: 405652843914
created_at: '2021-02-01T15:17:51Z'
locale: en-us
permission_group_id: 237867
section_id: 7513289222427
user_segment_id: null
html_url: >-
https://support.circleci.com/hc/en-us/articles/360055901372-Auto-cancel-re-run-if-newer-commit-exists
https://support.circleci.com/hc/en-us/articles/360055901372-Auto-Cancel-Re-Run-if-Newer-Commit-Exists
draft: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<h1>Timeout Limit</h1>
<p>CircleCI has a built-in <strong>10 minute</strong> no-output timeout. This means that if it has been 10 minutes since the last output, the build will be canceled and stopped.</p>
<p>This can cause users to encounter issues where they intend for a part of their build to continue beyond 10 minutes without giving output, but the system kills the process/job.</p>
<h2> </h2>
<h2>Adjusting the timeout</h2>
<p>The <code style="background-color: #f3f3f3;">no_output_timeout</code> parameter for <a href="https://circleci.com/docs/2.0/configuration-reference/#run">run</a> gives users the option to change the no-output timeout from the default 10 minutes to a user-specified timeout.</p>
<p> </p>
<p>For example, if we have a run step as follows:</p>
<pre style="background-color: #f3f3f3;">- run: <br> command: . ./ourlongscript.sh </pre>
<p> </p>
<p>If we expect our script will take a while to complete execution, we can extend the no-output timeout as follows:</p>
<pre style="background-color: #f3f3f3;">- run: <br> command: . ./ourlongscript.sh<br> no_output_timeout: 30m</pre>
<p> </p>
<p>The value set for no_output_timeout can be in hours, minutes or seconds - a digit followed by h, m or s respectively. Partial times can also be used, like 1.5h. Please see the examples below:</p>
<pre style="background-color: #f3f3f3;">no_output_timeout: 30s<br>no_output_timeout: 30m<br>no_output_timeout: 3h<br>no_output_timeout: 1.5h<strong><br></strong></pre>
<p> </p>
<h2>Additional Notes:</h2>
<ul>
<li>There are cases when a job may run for longer than the timeout limit (a common case being test runners not exiting).</li>
<li>This will not override your build time limits enforced by your organization's plan.</li>
</ul>
<p> </p>
<h2>Additional Resources:</h2>
<ul>
<li><a href="https://support.circleci.com/hc/en-us/articles/4410707277083-Context-deadline-exceeded-after-1-hour-Build-timed-out-Free-tier-only-" target="_blank" rel="noopener">Context deadline exceeded after 1 hour - Build timed out (Free tier only)</a></li>
<li><a href="https://support.circleci.com/hc/en-us/articles/4411204604059-Automatically-cancel-build-after-set-amount-of-time" target="_blank" rel="noopener">Automatically cancel build after set amount of time</a></li>
</ul>
<p> </p>

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
<p>You may encounter a situation where you are overhauling your <code>config.yml</code> file and don't want to run a build on each change.</p>
<p>While you work on the changes you can add the following to the start (after the <code>- checkout</code> step) in each of the workflow jobs:</p>
<h1>Prevent Build With Only Config Changes</h1>
<p>You may encounter a situation where you are overhauling your <code style="background-color: #f3f3f3;">config.yml</code> file and don't want to run a build on each change.</p>
<p> </p>
<h2>circleci-agent step halt Command</h2>
<p>While you work on the changes you can add the following to the start (after the <code style="background-color: #f3f3f3;">- checkout</code> step) in each of the workflow jobs:</p>
<pre style="background-color: #f3f3f3;">- run: |
changes=`git show --name-only ${CIRCLE_SHA1} | tail -n +7`

Expand All @@ -8,4 +11,12 @@
circleci-agent step halt
fi</pre>
<p>This will check to see which files changed in the commit, and if it's only the configuration file, it will exit the job successfully with the <a href="https://circleci.com/docs/2.0/configuration-reference/#ending-a-job-from-within-a-step" target="_blank" rel="noopener">"circleci-agent step halt" command</a></p>
<p>Once you are happy with the changes in your configuration file you can remove the above run step and it will start to process your builds as normal.</p>
<p>Once you are happy with the changes in your configuration file you can remove the above run step and it will start to process your builds as normal.</p>
<p> </p>
<h2>[ci skip] Within Commit Message</h2>
<p>Another option is to add "[ci skip]" within your commit message to prevent a build when commiting changes to your <code style="background-color: #f3f3f3;">config.yml</code> file.</p>
<p> </p>
<h2>Additional Resources</h2>
<ul>
<li><a href="https://circleci.com/docs/skip-build" target="_blank" rel="noopener">Skip or cancel jobs and workflows</a></li>
</ul>
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<h1>Exiting Build From Run Step</h1>
<p>There are situations where re-running a build would cause issues, such as deploying a stale version of your application. To work around this the following run step will exit a build if a newer commit exists on the branch it is running on:</p>
<pre style="background-color: #f3f3f3;">- run:
name: Check last commit to this commit
Expand All @@ -11,4 +12,10 @@
fi</pre>
<p>Example of this in action:</p>
<p><img src="https://support.circleci.com/hc/article_attachments/360084358852/testing_cancel.png" alt="testing_cancel.png"></p>
<p>Build 714 runs successfully, I then make a change and push that commit up, and build 715 runs successfully. Then I re-run build 714 which fails since it found a newer commit on the branch.</p>
<p>Build 714 runs successfully, I then make a change and push that commit up, and build 715 runs successfully. Then I re-run build 714 which fails since it found a newer commit on the branch.</p>
<p> </p>
<h2>Additional Resources</h2>
<ul>
<li><a href="https://support.circleci.com/hc/en-us/articles/360058421851-Auto-cancel-workflow-via-run-step" target="_blank" rel="noopener">Auto-cancel workflow via run step</a></li>
<li><a href="https://circleci.com/docs/skip-build" target="_blank" rel="noopener">Skip or cancel jobs and workflows</a></li>
</ul>
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<p>You may have a situation where you need to dynamically change or update a file within the Windows executor. Usually, this would to update a config file. If the file is in XML, the following is an example of how such an update would be made:</p>
<h1>Updating Files</h1>
<p>You may have a situation where you need to dynamically change or update a file within the Windows executor. Usually, this would be to update a config file.</p>
<p> </p>
<h2>XML File Change Example</h2>
<p>If the file you need to change is written in XML, the following is an example of how such an update would be made:</p>
<pre style="background-color: #f3f3f3;">jobs:
build:
machine:
Expand All @@ -21,4 +25,9 @@
type C:\Users\circleci\project\test.config</pre>
<p>The above run command is adjusting the URL present in the following <code>test.config</code> file:</p>
<p><img src="https://support.circleci.com/hc/article_attachments/360084687952/Screen_Shot_2021-02-03_at_2.27.02_PM.png" alt="Screen_Shot_2021-02-03_at_2.27.02_PM.png"></p>
<p>The <code>Write-Host</code> commands are present just to verify the change and can be removed as needed.</p>
<p>The <code>Write-Host</code> commands are present just to verify the change and can be removed as needed.</p>
<p> </p>
<h2>Additional Resources</h2>
<ul>
<li><a href="https://circleci.com/docs/dynamic-config" target="_blank" rel="noopener">Dynamic Configuration</a></li>
</ul>
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<h1>Features That Help Limit Building</h1>
<p>There may be instances where you only want builds to run for specific users. While we don't have a setting to list specific users as being able to run builds, we do have some features that can help limit builds.</p>
<h2>Utilize restricted contexts</h2>
<p>If a context is used on a workflow, and the user running the build doesn't have access to the context, we will fail the build with an "Unauthorized" error. Information on setting up restricted contexts here:</p>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
<h1>Runtime Isolation</h1>
<p>All containers and VMs on CircleCI Cloud are isolated, or sandboxed, from each other. This means you cannot communicate directly with containers running in other jobs, even they are within the same project or org.</p>
<p>The exception to this rule are containers that run <em>within</em> the same job, known as secondary service containers, or the Remote Docker environment.</p>
<p>All jobs run in a freshly created container/VM, so there are no leftover, or cached, items at the beginning of a job. At the end of each job the container is destroyed for security purposes, so you can be assured any leftover files are not stored unless your config explicitly uploads these as artifacts.</p>
<p>For more information on our Data Security Policy, please see: <a href="https://circleci.com/security/">Data Security Policy - CircleCI</a></p>
<p>All jobs run in a freshly created container/VM, so by default there are no leftover, or cached, items at the beginning of a job. At the end of each job the container is destroyed for security purposes, so you can be assured any leftover files are not stored unless your config explicitly uploads these as artifacts.</p>
<p>For more information on our Data Security Policy, please see: <a href="https://circleci.com/security/">Data Security Policy - CircleCI</a></p>
<p> </p>
<h2>Additional Resources</h2>
<ul>
<li><a href="https://circleci.com/docs/persist-data" target="_blank" rel="noopener">Persisting Data Overview</a></li>
<li><a href="https://circleci.com/docs/caching" target="_blank" rel="noopener">Caching Dependencies</a></li>
</ul>
2 changes: 1 addition & 1 deletion data/categories/115001866207-Using-CircleCI_en-us.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ url: >-
https://circleci.zendesk.com/api/v2/help_center/en-us/categories/115001866207.json
html_url: https://support.circleci.com/hc/en-us/categories/115001866207-Using-CircleCI
created_at: '2017-08-26T09:00:14Z'
updated_at: '2022-09-17T00:00:57Z'
updated_at: '2022-09-19T22:12:30Z'
name: Using CircleCI
description: >-
Solutions and debugging strategies for problems you may face while using
Expand Down
2 changes: 1 addition & 1 deletion data/categories/115001866207_ja.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ url: >-
https://circleci.zendesk.com/api/v2/help_center/ja/categories/115001866207.json
html_url: https://support.circleci.com/hc/ja/categories/115001866207
created_at: '2017-08-26T09:00:14Z'
updated_at: '2022-09-17T00:00:57Z'
updated_at: '2022-09-19T22:12:30Z'
name: "\x10CircleCIを使う"
description: CircleCIの設定レファレンス、YAMLのコンフィグオプション、セッティングと機能について
locale: ja
Expand Down
2 changes: 1 addition & 1 deletion data/categories/115001914008-Mobile_en-us.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ url: >-
https://circleci.zendesk.com/api/v2/help_center/en-us/categories/115001914008.json
html_url: https://support.circleci.com/hc/en-us/categories/115001914008-Mobile
created_at: '2017-09-06T14:55:41Z'
updated_at: '2022-09-16T12:15:22Z'
updated_at: '2022-09-20T00:56:17Z'
name: Mobile
description: iOS and Android testing and deployment.
locale: en-us
Expand Down
2 changes: 1 addition & 1 deletion data/categories/115001914008_ja.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ url: >-
https://circleci.zendesk.com/api/v2/help_center/ja/categories/115001914008.json
html_url: https://support.circleci.com/hc/ja/categories/115001914008
created_at: '2017-09-06T14:55:41Z'
updated_at: '2022-09-16T12:15:22Z'
updated_at: '2022-09-20T00:56:17Z'
name: モバイルアプリ
description: "iOSとAndroidのテストとデプロイメント\r\n\r\n"
locale: ja
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ url: >-
html_url: >-
https://support.circleci.com/hc/en-us/categories/115001919067-Accounts-Permissions-and-Billing
created_at: '2017-09-06T15:14:58Z'
updated_at: '2022-09-18T18:42:23Z'
updated_at: '2022-09-19T20:55:04Z'
name: Accounts, Permissions, and Billing
description: Signing up, logging in, payment, GitHub and Bitbucket authorization issues.
locale: en-us
Expand Down
2 changes: 1 addition & 1 deletion data/categories/115001919067_ja.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ url: >-
https://circleci.zendesk.com/api/v2/help_center/ja/categories/115001919067.json
html_url: https://support.circleci.com/hc/ja/categories/115001919067
created_at: '2017-09-06T15:14:58Z'
updated_at: '2022-09-18T18:42:23Z'
updated_at: '2022-09-19T20:55:04Z'
name: アカウント、権限、請求
description: サインアップ、ログイン、支払い、GitHubとBitbucketでの認証について
locale: ja
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ url: >-
html_url: >-
https://support.circleci.com/hc/en-us/categories/360000427854-Working-With-Support
created_at: '2018-05-21T07:31:10Z'
updated_at: '2022-09-18T17:45:01Z'
updated_at: '2022-09-19T18:00:17Z'
name: Working With Support
description: General questions about CircleCI including security and certification.
locale: en-us
Expand Down
2 changes: 1 addition & 1 deletion data/categories/360000427854_ja.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ url: >-
https://circleci.zendesk.com/api/v2/help_center/ja/categories/360000427854.json
html_url: https://support.circleci.com/hc/ja/categories/360000427854
created_at: '2018-05-21T07:31:10Z'
updated_at: '2022-09-18T17:45:01Z'
updated_at: '2022-09-19T18:00:17Z'
name: その他
description: "セキュリティ、認定、その他CircleCIに関する質問\r\n\r\n"
locale: ja
Expand Down
2 changes: 1 addition & 1 deletion data/categories/360006019192-API_en-us.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ url: >-
https://circleci.zendesk.com/api/v2/help_center/en-us/categories/360006019192.json
html_url: https://support.circleci.com/hc/en-us/categories/360006019192-API
created_at: '2021-04-15T16:25:56Z'
updated_at: '2022-09-14T12:48:58Z'
updated_at: '2022-09-19T14:11:30Z'
name: API
description: ''
locale: en-us
Expand Down
2 changes: 1 addition & 1 deletion data/categories/360006019192_ja.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ url: >-
https://circleci.zendesk.com/api/v2/help_center/ja/categories/360006019192.json
html_url: https://support.circleci.com/hc/ja/categories/360006019192-API
created_at: '2021-04-15T16:25:56Z'
updated_at: '2022-09-14T12:48:58Z'
updated_at: '2022-09-19T14:11:30Z'
name: API
description: ''
locale: ja
Expand Down

0 comments on commit fae75ed

Please sign in to comment.