diff --git a/content/doc/book/pipeline/pipeline-as-code.adoc b/content/doc/book/pipeline/pipeline-as-code.adoc index b75a16f16cc1..86b658f85ea0 100644 --- a/content/doc/book/pipeline/pipeline-as-code.adoc +++ b/content/doc/book/pipeline/pipeline-as-code.adoc @@ -77,37 +77,29 @@ available in the configuration screen for a Jenkins _Pipeline_ job. Using the _Snippet Generator_, you can create a Pipeline script as you might through the dropdowns in other Jenkins jobs. - -== Folder Computation - -_Multibranch Pipeline_ projects and _Organization Folders_ extend the existing -folder functionality by introducing 'computed' folders. Computed folders -automatically run a process to manage the folder contents. This computation, in -the case of _Multibranch Pipeline_ projects, creates child items for each -eligible branch within the child. For _Organization Folders_, computation -populates child items for repositories as individual _Multibranch Pipelines_. - -Folder computation may happen automatically via webhook callbacks, as branches -and repositories are created or removed. Computation may also be triggered by -the _Build Trigger_ defined in the configuration, which will automatically run a -computation task after a period of inactivity (this defaults to run after one -day). - +[[folder-computation]] +== Multibranch Pipeline and Organization Folder + +*Multibranch Pipeline* projects and *GitHub Organization Folders* extend Jenkins' folder functionality by introducing computed folders, which automatically manage their contents by dynamically creating and updating child items. +These features require the plugin:github-branch-source[*GitHub Branch Source*] plugin to be installed, as it provides the necessary functionality for managing branches and repositories. + +* **Multibranch Pipeline Projects:** The computed folder functionality includes **Scan Multibranch Pipeline Log** and **Scan Multibranch Pipeline Now** options, which dynamically manage pipeline items. +These options allow Jenkins to scan repositories, generate child items for eligible branches, and automatically update the pipeline list based on changes. + +* **GitHub Organization Projects:** The computed folder functionality includes **Scan Organization Log** and **Scan Organization Now** options. +This functionality populates repositories as individual Multibranch Pipelines and provides insights into branch and repository scans. + +Folder scans can be automatically triggered through webhook callbacks whenever branches or repositories are created or removed. +Scans can also be configured to run periodically via the **Build Triggers** settings, which default to a re-scan after one day of inactivity. + [role="image-border"] -image::folder-computation-build-trigger-schedule.png[scaledwidth="75%"] - -Information about the last execution of the folder computation is available in -the *Folder Computation* section. - -[role="image-border"] -image::folder-computation-main.png[scaledwidth="75%",width="75%"] - -The log from the last attempt to compute the folder is available from this page. -If folder computation doesn't result in an expected set of repositories, the log -may have useful information to diagnose the problem. +image::github-organization-build-triggers-settings.png[alt = "Configuration page for the 'CloudBeersInc' project, of the GitHub Organization Folder type. In the 'Scan Organization Triggers' section the 'Periodically if not otherwise run' option is checked and the Interval is set to '1 day'.", width=80%] + +The log from the last attempt to scan the organization is available in the **Scan Organization Log**. +If the scan doesn’t produce the expected set of repositories, the log may contain useful information to help diagnose the issue. [role="image-border"] -image::folder-computation-log.png[scaledwidth="75%",width="75%"] +image::scan-organization-log.png[alt = "The 'Scan Organization Log' page in Jenkins for the 'CloudBeersInc' project, of the GitHub Organization Folder type, displays the scan's progress and results. The left panel contains various navigation options, with the 'Scan Organization Log' section selected. The log indicates that the scan was initiated by the user admin along with Time and Date information. It provides details about the scan's progress, including consulting GitHub for the repository CloudBeersInc/community-docs and processing the main branch.", scaledwidth=75%,width=80%] == Configuration diff --git a/content/doc/book/resources/pipeline-as-code/folder-computation-build-trigger-schedule.png b/content/doc/book/resources/pipeline-as-code/folder-computation-build-trigger-schedule.png deleted file mode 100644 index b671d78cf58e..000000000000 Binary files a/content/doc/book/resources/pipeline-as-code/folder-computation-build-trigger-schedule.png and /dev/null differ diff --git a/content/doc/book/resources/pipeline-as-code/folder-computation-log.png b/content/doc/book/resources/pipeline-as-code/folder-computation-log.png deleted file mode 100644 index 0f1089d70d54..000000000000 Binary files a/content/doc/book/resources/pipeline-as-code/folder-computation-log.png and /dev/null differ diff --git a/content/doc/book/resources/pipeline-as-code/folder-computation-main.png b/content/doc/book/resources/pipeline-as-code/folder-computation-main.png deleted file mode 100644 index a0eec2c274f3..000000000000 Binary files a/content/doc/book/resources/pipeline-as-code/folder-computation-main.png and /dev/null differ diff --git a/content/doc/book/resources/pipeline-as-code/github-organization-build-triggers-settings.png b/content/doc/book/resources/pipeline-as-code/github-organization-build-triggers-settings.png new file mode 100644 index 000000000000..4b6706d57dc2 Binary files /dev/null and b/content/doc/book/resources/pipeline-as-code/github-organization-build-triggers-settings.png differ diff --git a/content/doc/book/resources/pipeline-as-code/scan-organization-log.png b/content/doc/book/resources/pipeline-as-code/scan-organization-log.png new file mode 100644 index 000000000000..5b6e25058000 Binary files /dev/null and b/content/doc/book/resources/pipeline-as-code/scan-organization-log.png differ