diff --git a/jenkins/valet-audit-lab.md b/jenkins/valet-audit-lab.md index 29b77e8..6afb0a0 100644 --- a/jenkins/valet-audit-lab.md +++ b/jenkins/valet-audit-lab.md @@ -37,7 +37,7 @@ gh valet audit jenkins --output-dir tmp/audit ### Example -valet-audit-1 +valet-audit-1 ## View audit output @@ -50,7 +50,7 @@ The audit summary, logs, config files, jenkinsfiles, and transformed Actions Wor ### Example -valet-audit-2 +valet-audit-2 ## Review the pipelines @@ -58,13 +58,13 @@ The audit summary, logs, config files, jenkinsfiles, and transformed Actions Wor The audit summary starts by giving a summary of the types of pipelines that were extracted from Jenkins. -- It shows that there are a total of 4 pipelines extracted. +- It shows that there are a total of 7 pipelines extracted. -- 50% pipelines were successful. This means that Valet knew how to map all the constructs of the Jenkins pipeline to a GitHub Actions equivalent. All of the build pluggins and triggers that are referenced were all successfully converted into a GitHub Actions equivalent. +- 42% pipelines were successful. This means that Valet knew how to map all the constructs of the Jenkins pipeline to a GitHub Actions equivalent. All of the build pluggins and triggers that are referenced were all successfully converted into a GitHub Actions equivalent. -- 50% pipelines were partially successful. This means that Valet knew how to map all the constructs of the Jenkins pipeline but there may be a plugin that was referenced that Valet wasn't able to automatically map to a Github Actions equivalent. +- 42% pipelines were partially successful. This means that Valet knew how to map all the constructs of the Jenkins pipeline but there may be a plugin that was referenced that Valet wasn't able to automatically map to a Github Actions equivalent. -- 0% of these pipelines are unsupported. If there were any that would fall under this category, that would mean that those pipelines were using a pipeline type that is fundamentally not supported by Valet. If a Jenkins instance had any scripted pipelines they would appear here. +- 1% of these pipelines are unsupported. This means that the pipeline type is fundamentally unsupported by Valet. This is most likely a Jenkins scripted pipeline. - 0% of these fail altogether. If there were any pipelines that would fall under this category, that would mean that those pipelines were misconfigured or there was an issue with Valet. @@ -72,15 +72,15 @@ Under the `Job types` section, we can see that the `audit` command is able to su #### Example -valet-audit-3 +valet-audit-3 ### Build steps Under the `Build steps` section we can see a breakdown of the build steps that were used in these pipelines. -- Supported: 7/9 discrete build steps are considered known by Valet. When Valet encounters a build step of this type, it knows exactly how to map that into a GitHub Actions equivalent. -- Unknown: 2/9 discrete build steps are considered unknown by Valet. When Valet enounters a build step of this type, it does not yet know to map this automatically to a GitHub Action equivalent. -- Unsupported: There are currently no build steps that are unsupported so this category is not shown. If there were it would mean one of three things: +- Supported: 12/16 discrete build steps are considered known by Valet. When Valet encounters a build step of this type, it knows exactly how to map that into a GitHub Actions equivalent. +- Unknown: 2/16 discrete build steps are considered unknown by Valet. When Valet enounters a build step of this type, it does not yet know to map this automatically to a GitHub Action equivalent. +- Unsupported: 1/16 discrete build steps are considered unsupported by Valet. This could mean one of three things: 1. The way that plugin was configured for a given job is unsupported. 2. The plugin itself is fundamentally not supported in GitHub Actions. 3. It's supported by default in GitHub Actions. @@ -91,7 +91,7 @@ For example, if you are doing things like setting up the allow list of third-par #### Example -valet-audit-4 +valet-audit-4 ### Trigger, Environment, Other @@ -99,12 +99,16 @@ Similar to `Build steps`, there are `Trigger`, `Environment`, and a catch all `O ### Example -valet-audit-5 +valet-audit-5 ### Manual Tasks Under the Manual task section you will find a list of all the manual tasks that the pipelines would surface in a migration. Manual tasks are Valet's way of indicating tasks a user needs to do in order for a pipeline to be functional, such as adding `secrets`, or setting up a `self-hosted` runner. We will see how these manual tasks appear on a pull request when we do a migration in a lab later on. +### Example + +valet-audit-5 + ### Files At the end of the Audit Summary page you will find a list of all of the files that were written to disk. Generally, for any given pipeline, you’ll find 2 or 3 associated files. In these files are the actual converted GitHub Actions workflows. @@ -113,7 +117,7 @@ In addition, you’ll see a file that shows the raw JSON data that we pull from #### Example -valet-audit-6 +valet-audit-6 ### Next Lab