From 9b31bdeb5b975187dc200306dbaef6bf0eda0206 Mon Sep 17 00:00:00 2001 From: Davis Goodin Date: Mon, 6 Jul 2026 15:15:02 -0700 Subject: [PATCH 1/2] Update docs for pipeline info reachability --- README.md | 2 ++ eng/README.md | 2 ++ eng/ci-tools/README.md | 5 ++++- eng/pipeline/README.md | 8 ++++++++ 4 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 eng/pipeline/README.md diff --git a/README.md b/README.md index 467abbb8..0c915a36 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,8 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. +The [README in `eng`](/eng/README.md) contains more information about the build infrastructure for this repository. + ## Trademarks This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft diff --git a/eng/README.md b/eng/README.md index 2ea81a80..7b93558c 100644 --- a/eng/README.md +++ b/eng/README.md @@ -8,6 +8,8 @@ it matches the engineering directory used in microsoft/go, and also because auto-updates to the "eng/common" directory only work with this absolute location. +The Azure DevOps pipelines are described in the [`/eng/pipeline` README](/eng/pipeline/README.md). + ## Prerequisites * [PowerShell 6+](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell) diff --git a/eng/ci-tools/README.md b/eng/ci-tools/README.md index 329e3f0a..b0540183 100644 --- a/eng/ci-tools/README.md +++ b/eng/ci-tools/README.md @@ -3,4 +3,7 @@ This module exists to store CI dependencies. Using a module dependency lets CI download/install the tool while verifying against the checked-in go.sum file. This directory contains `local.Dockerfile`, which creates an image with `dockerupdate` installed. -See [eng/README.md#windows](../README.md#windows) for instructions on using it. \ No newline at end of file +See [eng/README.md#windows](../README.md#windows) for instructions on using it. + +This module also contains the code generator for the Azure DevOps build pipelines. +Use `go generate .` in this directory to regenerate the pipelines. diff --git a/eng/pipeline/README.md b/eng/pipeline/README.md new file mode 100644 index 00000000..923f06f9 --- /dev/null +++ b/eng/pipeline/README.md @@ -0,0 +1,8 @@ +# go-images build pipelines + +This directory contains the Azure DevOps build pipelines for the go-images repository. + +A code generator turns the `*.gen.yml` files into the actual `*.yml` files that Azure DevOps uses. +See [`eng/ci-tools/README.md`](../ci-tools/README.md) for more information about the code generator. + +See [Azure pipeline YML style](https://github.com/microsoft/go-infra/blob/main/docs/pipeline-yml-style.md) for more information about how these pipelines are written. From 7c4ad4b7914348a90b5082cd8d16e43bf81bdab2 Mon Sep 17 00:00:00 2001 From: Davis Goodin Date: Tue, 7 Jul 2026 09:51:23 -0700 Subject: [PATCH 2/2] Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- eng/pipeline/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eng/pipeline/README.md b/eng/pipeline/README.md index 923f06f9..3779ae2b 100644 --- a/eng/pipeline/README.md +++ b/eng/pipeline/README.md @@ -5,4 +5,4 @@ This directory contains the Azure DevOps build pipelines for the go-images repos A code generator turns the `*.gen.yml` files into the actual `*.yml` files that Azure DevOps uses. See [`eng/ci-tools/README.md`](../ci-tools/README.md) for more information about the code generator. -See [Azure pipeline YML style](https://github.com/microsoft/go-infra/blob/main/docs/pipeline-yml-style.md) for more information about how these pipelines are written. +See [Azure Pipelines YAML style](https://github.com/microsoft/go-infra/blob/main/docs/pipeline-yml-style.md) for more information about how these pipelines are written.