Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
92ff59f2
Commit
92ff59f2
authored
Nov 15, 2021
by
Marcel Amirault
Committed by
Fiona Neill
Nov 15, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add links to pipeline editor from quick start guide
parent
999f7403
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
13 additions
and
9 deletions
+13
-9
doc/ci/quick_start/index.md
doc/ci/quick_start/index.md
+5
-4
doc/ci/troubleshooting.md
doc/ci/troubleshooting.md
+8
-5
No files found.
doc/ci/quick_start/index.md
View file @
92ff59f2
...
...
@@ -119,6 +119,11 @@ The pipeline starts when the commit is committed.
#### `.gitlab-ci.yml` tips
-
After you create your first
`.gitlab-ci.yml`
file, use the
[
pipeline editor
](
../pipeline_editor/index.md
)
for all future edits to the file. With the pipeline editor, you can:
-
Edit the pipeline configuration with automatic syntax highlighting and validation.
-
View the
[
CI/CD configuration visualization
](
../pipeline_editor/index.md#visualize-ci-configuration
)
,
a graphical representation of your
`.gitlab-ci.yml`
file.
-
If you want the runner to
[
use a Docker container to run the jobs
](
../docker/using_docker_images.md
)
,
edit the
`.gitlab-ci.yml`
file
to include an image name:
...
...
@@ -136,10 +141,6 @@ The pipeline starts when the commit is committed.
Your application does not need to be built as a Docker container to
run CI/CD jobs in Docker containers.
-
To validate your
`.gitlab-ci.yml`
file, use the
[
CI Lint tool
](
../lint.md
)
, which is available in every project.
-
You can also use
[
CI/CD configuration visualization
](
../pipeline_editor/index.md#visualize-ci-configuration
)
to
view a graphical representation of your
`.gitlab-ci.yml`
file.
-
Each job contains scripts and stages:
-
The
[
`default`
](
../yaml/index.md#default
)
keyword is for
custom defaults, for example with
[
`before_script`
](
../yaml/index.md#before_script
)
...
...
doc/ci/troubleshooting.md
View file @
92ff59f2
...
...
@@ -16,12 +16,15 @@ This guide also lists common issues and possible solutions.
An early source of problems can be incorrect syntax. The pipeline shows a
`yaml invalid`
badge and does not start running if any syntax or formatting problems are found.
### Edit `gitlab-ci.yml` with the
Web IDE
### Edit `gitlab-ci.yml` with the
pipeline editor
The
[
GitLab Web IDE
](
../user/project/web_ide/index.md
)
offers advanced authoring tools,
including syntax highlighting for the
`.gitlab-ci.yml`
, and is the recommended editing
experience (rather than the single file editor). It offers code completion suggestions
that ensure you are only using accepted keywords.
The
[
pipeline editor
](
pipeline_editor/index.md
)
is the recommended editing
experience (rather than the single file editor or the Web IDE). It includes:
-
Code completion suggestions that ensure you are only using accepted keywords.
-
Automatic syntax highlighting and validation.
-
The
[
CI/CD configuration visualization
](
pipeline_editor/index.md#visualize-ci-configuration
)
,
a graphical representation of your
`.gitlab-ci.yml`
file.
If you prefer to use another editor, you can use a schema like
[
the Schemastore `gitlab-ci` schema
](
https://json.schemastore.org/gitlab-ci
)
with your editor of choice.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment