Skip to content

convert build cloud CI platform tabs to linkable sections #22111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 27, 2025
Merged

convert build cloud CI platform tabs to linkable sections #22111

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
915fa13
convert CI platform tabs to linkable sections
nico1510 Feb 26, 2025
71f8ea2
Apply suggestions from code review
aevesdocker Feb 27, 2025
4511e52
Apply suggestions from code review
aevesdocker Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 23 additions & 21 deletions content/manuals/build-cloud/ci.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,21 @@
> Builds on Docker Build Cloud have a timeout limit of two hours. Builds that
> run for longer than two hours are automatically cancelled.
{{< tabs >}}
{{< tab name="GitHub Actions" >}}
## CI Platform Examples

Check warning on line 35 in content/manuals/build-cloud/ci.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Docker.HeadingSentenceCase] Use sentence case for headings: 'CI Platform Examples'.

Raw Output:
{"message": "[Docker.HeadingSentenceCase] Use sentence case for headings: 'CI Platform Examples'.", "location": {"path": "content/manuals/build-cloud/ci.md", "range": {"start": {"line": 35, "column": 4}}}, "severity": "WARNING"}

Choose your CI platform to see detailed setup instructions:

- [GitHub Actions](#github-actions)
- [GitLab](#gitlab)
- [Circle CI](#circle-ci)
- [Buildkite](#buildkite)

Check failure on line 42 in content/manuals/build-cloud/ci.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Buildkite'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Buildkite'?", "location": {"path": "content/manuals/build-cloud/ci.md", "range": {"start": {"line": 42, "column": 4}}}, "severity": "ERROR"}
- [Jenkins](#jenkins)
- [Travis CI](#travis-ci)
- [BitBucket Pipelines](#bitbucket-pipelines)
- [Shell Script](#shell-script)
- [Docker Compose](#docker-compose)

### GitHub Actions {#github-actions}

Check failure on line 49 in content/manuals/build-cloud/ci.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'GitHub( Actions)?' instead of 'github'.

Raw Output:
{"message": "[Vale.Terms] Use 'GitHub( Actions)?' instead of 'github'.", "location": {"path": "content/manuals/build-cloud/ci.md", "range": {"start": {"line": 49, "column": 22}}}, "severity": "ERROR"}

> [!NOTE]
>
Expand Down Expand Up @@ -87,8 +100,7 @@
outputs: ${{ github.event_name == 'pull_request' && 'type=cacheonly' || 'type=registry' }}
```
{{< /tab >}}
{{< tab name="GitLab" >}}
### GitLab {#gitlab}
```yaml
default:
Expand Down Expand Up @@ -133,8 +145,7 @@
.
```
{{< /tab >}}
{{< tab name="Circle CI" >}}
### Circle CI {#circle-ci}
```yaml
version: 2.1
Expand Down Expand Up @@ -195,8 +206,7 @@
- build_push
```
{{< /tab >}}
{{< tab name="Buildkite" >}}
### Buildkite {#buildkite}

Check failure on line 209 in content/manuals/build-cloud/ci.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Buildkite'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Buildkite'?", "location": {"path": "content/manuals/build-cloud/ci.md", "range": {"start": {"line": 209, "column": 5}}}, "severity": "ERROR"}
The following example sets up a Buildkite pipeline using Docker Build Cloud. The
example assumes that the pipeline name is `build-push-docker` and that you
Expand Down Expand Up @@ -273,8 +283,7 @@
.
```

{{< /tab >}}
{{< tab name="Jenkins" >}}
### Jenkins {#jenkins}

```groovy
pipeline {
Expand Down Expand Up @@ -309,8 +318,7 @@
}
```

{{< /tab >}}
{{< tab name="Travis CI" >}}
### Travis CI {#travis-ci}

```yaml
language: minimal
Expand Down Expand Up @@ -341,8 +349,7 @@
--tag "$IMAGE_NAME" .
```
{{< /tab >}}
{{< tab name="BitBucket Pipelines" >}}
### BitBucket Pipelines {#bitbucket-pipelines}

Check warning on line 352 in content/manuals/build-cloud/ci.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Docker.HeadingSentenceCase] Use sentence case for headings: 'BitBucket Pipelines {#bitbucket-pipelines}'.

Raw Output:
{"message": "[Docker.HeadingSentenceCase] Use sentence case for headings: 'BitBucket Pipelines {#bitbucket-pipelines}'.", "location": {"path": "content/manuals/build-cloud/ci.md", "range": {"start": {"line": 352, "column": 5}}}, "severity": "WARNING"}
```yaml
# Prerequisites: $DOCKER_USER, $DOCKER_PAT setup as deployment variables
Expand Down Expand Up @@ -372,8 +379,7 @@
- docker
```
{{< /tab >}}
{{< tab name="Shell" >}}
### Shell Script {#shell-script}
```bash
#!/bin/bash
Expand Down Expand Up @@ -407,8 +413,7 @@
.
```

{{< /tab >}}
{{< tab name="Docker Compose" >}}
### Docker Compose {#docker-compose}

Use this implementation if you want to use `docker compose build` with
Docker Build Cloud in CI.
Expand Down Expand Up @@ -442,6 +447,3 @@
# Build the image build
docker compose build
```

{{< /tab >}}
{{< /tabs >}}