Skip to content

Commit 16517e7

Browse files
authored
Merge pull request circleci#4694 from circleci/tjs/4679
Clean: remove redundant workflows documents.
2 parents 6dea947 + b796f2e commit 16517e7

10 files changed

+25
-199
lines changed

jekyll/_cci2/configuration-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1041,7 +1041,7 @@ In general `deploy` step behaves just like `run` with two exceptions:
10411041

10421042
When using the `deploy` step, it is also helpful to understand how you can use workflows to orchestrate jobs and trigger jobs. For more information about using workflows, refer to the following pages:
10431043

1044-
- [Workflows](https://circleci.com/docs/2.0/workflows-overview/)
1044+
- [Workflows](https://circleci.com/docs/2.0/workflows/)
10451045
- [`workflows`](https://circleci.com/docs/2.0/configuration-reference/#section=configuration)
10461046

10471047
###### Example

jekyll/_cci2/orb-concepts.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,12 @@ For more information, see the guide to [Authoring Reusable Executors]({{site.bas
108108
109109
### Jobs
110110
111-
Jobs define a collection of [steps](https://circleci.com/docs/2.0/configuration-reference/#steps) to be run within a given [executor]({{site.baseurl}}/2.0/orb-concepts/#executors), and are orchestrated using [Workflows]({{site.baseurl}}/2.0/workflows-overview/). Jobs will also individually return their status via [GitHub Checks](https://circleci.com/docs/2.0/enable-checks/).
111+
Jobs define a collection of
112+
[steps](https://circleci.com/docs/2.0/configuration-reference/#steps) to be run
113+
within a given [executor]({{site.baseurl}}/2.0/orb-concepts/#executors), and are
114+
orchestrated using [Workflows]({{site.baseurl}}/2.0/workflows/). Jobs
115+
will also individually return their status via [GitHub
116+
Checks](https://circleci.com/docs/2.0/enable-checks/).
112117
113118
```yaml
114119
version: 2.1

jekyll/_cci2/workflows-not-starting.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

jekyll/_cci2/workflows-overview.md

Lines changed: 0 additions & 48 deletions
This file was deleted.

jekyll/_cci2/workflows-waiting-status.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

jekyll/_cci2/workflows.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,16 @@ For example, if only one job in a workflow fails, you will know it is failing in
3333

3434
Workflows may appear with one of the following states:
3535

36-
- RUNNING: Workflow is in progress
37-
- NOT RUN: Workflow was never started
38-
- CANCELLED: Workflow was cancelled before it finished
39-
- FAILING: A job in the workflow has failed. Workflows go into Failing state when one of the jobs within the graph has failed while other jobs are still running. Failing state indicates that the workflow is eventually going to fail.
40-
- FAILED: One or more jobs in the workflow failed. Failed state is when one or more jobs in the workflow graph have failed. Failed is a terminal state.
41-
- SUCCESS: All jobs in the workflow completed successfully
42-
- ON HOLD: A job in the workflow is waiting for approval
43-
- NEEDS SETUP: A workflow stanza is not included or is incorrect in the [config.yml file]({{ site.baseurl }}/2.0/configuration-reference/) for this project
36+
| State | Description |
37+
|-------|-------------|
38+
| RUNNING | Workflow is in progress |
39+
| NOT RUN | Workflow was never started |
40+
| CANCELLED | Workflow was cancelled before it finished |
41+
| FAILING | A job in the workflow has failed |
42+
| FAILED | One or more jobs in the workflow failed |
43+
| SUCCESS | All jobs in the workflow completed successfully |
44+
| ON HOLD | A job in the workflow is waiting for approval |
45+
| NEEDS SETUP | A workflow stanza is not included or is incorrect in the [config.yml]({{ site.baseurl }}/2.0/configuration-reference/) file for this project |
4446

4547
### Limitations
4648
{:.no_toc}
@@ -523,6 +525,13 @@ When you use workflows, you increase your ability to rapidly respond to failures
523525

524526
This section describes common problems and solutions for Workflows.
525527

528+
### Workflow and Subsequent Jobs Do Not Trigger
529+
530+
If you do not see your workflows triggering, a common cause is a configuration error
531+
preventing the workflow from starting. As a result, the workflow does not start
532+
any jobs. Navigate to your project's pipelines and click on your workflow name
533+
to discern what might be failing.
534+
526535
### Rerunning Workflows Fails
527536
{:.no_toc}
528537

jekyll/_cci2_ja/configuration-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1010,7 +1010,7 @@ steps:
10101010

10111011
`deploy` ステップを使用するときには、ワークフローを使用してジョブのオーケストレーションやトリガーを実行する方法を理解しておくことをお勧めします。 ワークフローの使用方法については、以下を参照してください。
10121012

1013-
- [ワークフロー](https://circleci.com/docs/2.0/workflows-overview/)
1013+
- [ワークフロー](https://circleci.com/docs/2.0/workflows/)
10141014
- [`workflows`](https://circleci.com/docs/2.0/configuration-reference/#section=configuration)
10151015

10161016
###### 例

jekyll/_cci2_ja/workflows-not-starting.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

jekyll/_cci2_ja/workflows-overview.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

jekyll/_cci2_ja/workflows-waiting-status.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

0 commit comments

Comments
 (0)