mirror of
https://github.com/docker/docs.git
synced 2026-03-27 14:28:47 +07:00
Merge branch 'main' into repo-level-logos
This commit is contained in:
17
.github/CODEOWNERS
vendored
17
.github/CODEOWNERS
vendored
@@ -5,20 +5,25 @@
|
||||
|
||||
/build/ @crazy-max @jedevc @dvdksn
|
||||
|
||||
/compose/ @usha-mandya @aevesdocker
|
||||
/compose/ @aevesdocker
|
||||
|
||||
/desktop/ @aevesdocker
|
||||
|
||||
/docker-hub/ @jerae-duffin @craig-osterhout
|
||||
/desktop/extensions/ @ChrisChinchilla
|
||||
|
||||
/desktop/extensions-sdk/ @ChrisChinchilla
|
||||
|
||||
/scout/ @ChrisChinchilla
|
||||
|
||||
/docker-hub/ @aevesdocker @craig-osterhout
|
||||
|
||||
/engine/ @dvdksn
|
||||
|
||||
/subscription/ @jerae-duffin
|
||||
/subscription/ @aevesdocker
|
||||
|
||||
/docker-hub/publish/ @dvdksn
|
||||
/docker-hub/publish/ @ChrisChinchilla
|
||||
|
||||
/docker-hub/official_images/ @dvdksn
|
||||
/docker-hub/official_images/ @ChrisChinchilla
|
||||
|
||||
/registry/ @dvdksn
|
||||
|
||||
/atomist/ @dvdksn
|
||||
|
||||
2
.github/vale/Docker/Acronyms.yml
vendored
2
.github/vale/Docker/Acronyms.yml
vendored
@@ -63,3 +63,5 @@ exceptions:
|
||||
- XSS
|
||||
- YAML
|
||||
- ZIP
|
||||
- SBOM
|
||||
- CVE
|
||||
|
||||
1
.github/vale/Docker/ComplexWords.yml
vendored
1
.github/vale/Docker/ComplexWords.yml
vendored
@@ -63,6 +63,7 @@ swap:
|
||||
facilitate: ease
|
||||
females: women
|
||||
finalize: complete|finish
|
||||
illustrate: show
|
||||
itemized: listed
|
||||
jeopardize: risk
|
||||
liaise: work with|partner with
|
||||
|
||||
2
.github/vale/Docker/Contractions.yml
vendored
2
.github/vale/Docker/Contractions.yml
vendored
@@ -2,6 +2,8 @@ extends: substitution
|
||||
message: "Consider using '%s' instead of '%s'."
|
||||
level: warning
|
||||
ignorecase: true
|
||||
action:
|
||||
name: replace
|
||||
swap:
|
||||
are not: aren't
|
||||
cannot: can't
|
||||
|
||||
2
.github/vale/Docker/Substitute.yml
vendored
2
.github/vale/Docker/Substitute.yml
vendored
@@ -3,6 +3,8 @@ message: "Consider using '%s' instead of '%s'"
|
||||
link: https://docs.docker.com/contribute/style/recommended-words/
|
||||
ignorecase: true
|
||||
level: suggestion
|
||||
action:
|
||||
name: replace
|
||||
swap:
|
||||
'\b(?:eg|e\.g\.)[\s,]': for example
|
||||
'\b(?:ie|i\.e\.)[\s,]': that is
|
||||
|
||||
1
.github/vale/Vocab/Docker/accept.txt
vendored
1
.github/vale/Vocab/Docker/accept.txt
vendored
@@ -1,4 +1,5 @@
|
||||
(Certified|Verified) Publisher( Program)?
|
||||
Docker-Sponsored Open Source
|
||||
Autotest
|
||||
BuildKit
|
||||
Docker
|
||||
|
||||
8
.github/vale/Vocab/Industry/accept.txt
vendored
8
.github/vale/Vocab/Industry/accept.txt
vendored
@@ -1,6 +1,7 @@
|
||||
ARM
|
||||
AWS
|
||||
Amazon
|
||||
Ambassador
|
||||
Anchore
|
||||
Apple
|
||||
Artifactory
|
||||
@@ -9,6 +10,7 @@ BusyBox
|
||||
CentOS
|
||||
Ceph
|
||||
CloudFront
|
||||
CNCF
|
||||
Codefresh
|
||||
CouchDB
|
||||
Couchbase
|
||||
@@ -17,6 +19,7 @@ Django
|
||||
Fargate
|
||||
Fedora
|
||||
Flink
|
||||
Gefyra
|
||||
GeoNetwork
|
||||
GitHub( Actions)?
|
||||
Google
|
||||
@@ -54,6 +57,7 @@ Snyk
|
||||
Solr
|
||||
SonarQube
|
||||
Syft
|
||||
Telepresence
|
||||
TLS
|
||||
Twilio
|
||||
Ubuntu
|
||||
@@ -62,5 +66,9 @@ Wasm
|
||||
Windows
|
||||
XWiki
|
||||
Zsh
|
||||
kubefwd
|
||||
ktunnel
|
||||
macOS
|
||||
minikube
|
||||
sandbox
|
||||
sandboxed
|
||||
2
.github/vale/Vocab/Technology/accept.txt
vendored
2
.github/vale/Vocab/Technology/accept.txt
vendored
@@ -1,4 +1,5 @@
|
||||
APIs?
|
||||
CVEs?
|
||||
DHCP
|
||||
DNS
|
||||
Ethernet
|
||||
@@ -13,6 +14,7 @@ JPEG
|
||||
MAC
|
||||
RPM
|
||||
PNG
|
||||
SARIF
|
||||
SDKs?
|
||||
SSO
|
||||
TCP
|
||||
|
||||
31
.github/workflows/merge.yml
vendored
Normal file
31
.github/workflows/merge.yml
vendored
Normal file
@@ -0,0 +1,31 @@
|
||||
name: merge
|
||||
|
||||
# open or update publishing PR when there is a push to main
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
main-to-published:
|
||||
runs-on: ubuntu-22.04
|
||||
if: github.repository_owner == 'docker'
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
with:
|
||||
ref: published
|
||||
- name: Reset published branch
|
||||
run: |
|
||||
git fetch origin main:main
|
||||
git reset --hard main
|
||||
- name: Create Pull Request
|
||||
uses: peter-evans/create-pull-request@5b4a9f6a9e2af26e5f02351490b90d01eb8ec1e5
|
||||
with:
|
||||
delete-branch: false
|
||||
branch: published-update
|
||||
commit-message: publish updates from main
|
||||
labels: area/release
|
||||
title: publish updates from main
|
||||
body: |
|
||||
Automated pull request for publishing docs updates.
|
||||
41
.github/workflows/validate-upstream.yml
vendored
41
.github/workflows/validate-upstream.yml
vendored
@@ -16,6 +16,9 @@ on:
|
||||
data-files-folder:
|
||||
required: false
|
||||
type: string
|
||||
data-files-placeholder-folder:
|
||||
required: false
|
||||
type: string
|
||||
|
||||
jobs:
|
||||
run:
|
||||
@@ -64,7 +67,7 @@ jobs:
|
||||
yq _config.yml
|
||||
# cleanup js-yaml module and data files
|
||||
rm -rf ./node_modules
|
||||
if [ -n "./_data/${{ inputs.data-files-folder }}" ]; then
|
||||
if [[ -n "${{ inputs.data-files-folder }}" ]] && [[ -d "./_data/${{ inputs.data-files-folder }}" ]]; then
|
||||
rm -rf ./_data/${{ inputs.data-files-folder }}/*
|
||||
fi
|
||||
-
|
||||
@@ -73,7 +76,41 @@ jobs:
|
||||
if: ${{ inputs.data-files-id != '' && inputs.data-files-folder != '' }}
|
||||
with:
|
||||
name: ${{ inputs.data-files-id }}
|
||||
path: ./_data/${{ inputs.data-files-folder }}
|
||||
path: /tmp/_data/${{ inputs.data-files-folder }}
|
||||
-
|
||||
# Copy data files from /tmp/_data/${{ inputs.data-files-folder }} to
|
||||
# _data/${{ inputs.data-files-folder }}. If data-files-placeholder-folder
|
||||
# is set, then check if a placeholder file exists for each data file in
|
||||
# that folder. If not, then creates a placeholder file with the same
|
||||
# name as the data file, but with a .md extension.
|
||||
name: Copy data files
|
||||
if: ${{ inputs.data-files-id != '' && inputs.data-files-folder != '' }}
|
||||
uses: actions/github-script@v6
|
||||
with:
|
||||
script: |
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const dataFilesPlaceholderFolder = `${{ inputs.data-files-placeholder-folder }}`;
|
||||
const globber = await glob.create(`/tmp/_data/${{ inputs.data-files-folder }}/*.yaml`);
|
||||
for await (const yamlSrcPath of globber.globGenerator()) {
|
||||
const yamlSrcFilename = path.basename(yamlSrcPath);
|
||||
const yamlDestPath = path.join('_data', `${{ inputs.data-files-folder }}`, yamlSrcFilename);
|
||||
const placeholderPath = path.join(dataFilesPlaceholderFolder, yamlSrcFilename.replace(/^docker_/, '').replace(/\.yaml$/, '.md'));
|
||||
if (dataFilesPlaceholderFolder !== '' && !fs.existsSync(placeholderPath)) {
|
||||
const placeholderContent = `---
|
||||
datafolder: ${{ inputs.data-files-folder }}
|
||||
datafile: ${yamlSrcFilename.replace(/\.[^/.]+$/, '')}
|
||||
title: ${yamlSrcFilename.replace(/\.[^/.]+$/, "").replaceAll('_', ' ')}
|
||||
---
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}`;
|
||||
await core.group(`creating ${placeholderPath}`, async () => {
|
||||
core.info(placeholderContent);
|
||||
});
|
||||
await fs.writeFileSync(placeholderPath, placeholderContent);
|
||||
}
|
||||
core.info(`${yamlSrcPath} => ${yamlDestPath}`);
|
||||
await fs.copyFileSync(yamlSrcPath, yamlDestPath);
|
||||
}
|
||||
-
|
||||
name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v2
|
||||
|
||||
Reference in New Issue
Block a user