Skip to content

docs(ci): clarify credentials setup for DBC CI/CD #22587

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.

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 1 commit into from
May 5, 2025

Conversation

nico1510
Copy link
Member

@nico1510 nico1510 commented May 5, 2025

Description

This PR updates the Docker Build Cloud CI documentation to clarify the setup of credentials for CI/CD pipelines. The changes include:

  • Renaming the section to “Setting up credentials for CI/CD” and integrating guidance on both access tokens and the required username (DOCKER_USER).
  • Explaining when to use an organization access token (OAT) versus a personal access token (PAT), and which value to use for DOCKER_USER in each case.
  • Updating the build timeout note from 2 hours to 90 minutes.

Related issues or tickets

N/A – Documentation improvement and clarification.

Reviews

  • Technical review — Confirm technical accuracy of credential setup and variable usage.
  • Editorial review — Check for clarity, consistency, and adherence to Docker copy guidelines.
  • Product review — Ensure the documentation aligns with product requirements and user needs.

…t - Rename section to 'Setting up credentials for CI/CD' and integrate username guidance (DOCKER_USER) with access token setup - Clarify when to use organization access tokens (OAT) vs personal access tokens (PAT), and which username to use for each - Add concise instructions and remove redundant tables for a more streamlined setup flow - Add a prominent note on required CI/CD variables (DOCKER_PAT and DOCKER_USER) - Update build timeout note from 2 hours to 90 minutes - Update code comments to reference the correct documentation section for access tokens. This improves clarity and ensures users configure their CI/CD pipelines with the correct credentials for Docker Build Cloud.
Copy link

netlify bot commented May 5, 2025

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 3e648b5
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/6818e913af07610008265d47
😎 Deploy Preview https://deploy-preview-22587--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@craig-osterhout craig-osterhout requested a review from a team May 5, 2025 16:38
Copy link
Contributor

@craig-osterhout craig-osterhout left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you. LGTM.

@craig-osterhout craig-osterhout merged commit 7543797 into docker:main May 5, 2025
13 of 14 checks passed
sarahsanders-docker pushed a commit to sarahsanders-docker/docs that referenced this pull request May 9, 2025
## Description

This PR updates the Docker Build Cloud CI documentation to clarify the
setup of credentials for CI/CD pipelines. The changes include:

- Renaming the section to “Setting up credentials for CI/CD” and
integrating guidance on both access tokens and the required username
(`DOCKER_USER`).
- Explaining when to use an organization access token (OAT) versus a
personal access token (PAT), and which value to use for `DOCKER_USER` in
each case.
- Updating the build timeout note from 2 hours to 90 minutes.


## Related issues or tickets

N/A – Documentation improvement and clarification.

## Reviews

- [ ] Technical review — Confirm technical accuracy of credential setup
and variable usage.
- [ ] Editorial review — Check for clarity, consistency, and adherence
to Docker copy guidelines.
- [ ] Product review — Ensure the documentation aligns with product
requirements and user needs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants