@invarn/cli 0.9.261 → 0.9.262

package/README.md

@@ -47,6 +47,36 @@ Nothing leaves your machine without a `y`: secret discovery only looks for the
 keys your pipeline itself declares and leaves empty, values are never printed,
 and the upload sits behind one confirmation that defaults to No.
 
+### How pushes and pull requests build
+
+Pushes and pull requests build from the `trigger_map` of the project's
+pipeline. Which pipeline that is depends on your default branch:
+
+- **No `.ci/pipelines/cibuild.yml` on the default branch.** Invarn builds
+  from the pipeline it generated when you added the project (the one you see
+  in the dashboard), with its triggers and its YAML. Nothing has to be
+  committed for builds to run.
+- **`.ci/pipelines/cibuild.yml` on the default branch.** Committing it on the
+  default branch replaces the generated pipeline: from the push that adds it
+  on, every push and pull request builds from the files in your repository.
+  A branch or pull request that adds the file keeps building from the
+  generated pipeline until the file is merged into the default branch.
+
+Other pipeline files in `.ci/pipelines/` (an agent's, say) do not replace the
+generated pipeline. Each one builds from the repository at the pushed commit
+whenever its own `trigger_map` matches, so one push can start both a build of
+the generated pipeline and a build of each other matching file. Agent
+pipelines only ever build from a file in the repository.
+
+While a new project is still setting up its first build (or waiting for the
+secrets it needs), pushes from the generated pipeline do not build; the first
+build starts by itself when setup is done.
+
+To stop builds, disconnect the repository in the dashboard (Settings →
+Connections; this deletes the project). Removing the pipeline file from the
+default branch does not stop them; Invarn goes back to building from the
+generated pipeline.
+
 ## Getting Started
 
 ### 1. Authenticate