Use code block for markdown

This commit is contained in:
Matisse Hack
2022-09-16 15:51:59 -07:00
parent 90838a009f
commit c104913e50
+110 -96
View File
@@ -69,24 +69,28 @@ The audit summary, logs, config files, jenkinsfiles, and transformed workflows w
The pipeline summary section contains high level statistics regarding the conversion rate done by Valet: The pipeline summary section contains high level statistics regarding the conversion rate done by Valet:
> Total: __7__ ```md
> ## Pipelines
> - Successful: __3 (42%)__
> - Partially successful: __3 (42%)__ Total: **7**
> - Unsupported: __1 (14%)__
> - Failed: __0 (0%)__ - Successful: **3 (42%)**
> - Partially successful: **3 (42%)**
> ### Job types - Unsupported: **1 (14%)**
> - Failed: **0 (0%)**
> Supported: __6 (85%)__
> ### Job types
> - flow-definition: __3__
> - project: __2__ Supported: **6 (85%)**
> - org.jenkinsci.plugins.workflow.multibranch.WorkflowMultiBranchProject: __1__
> - flow-definition: **3**
> Unsupported: __1 (14%)__ - project: **2**
> - org.jenkinsci.plugins.workflow.multibranch.WorkflowMultiBranchProject: **1**
> - scripted: __1__
Unsupported: **1 (14%)**
- scripted: **1**
```
Here are some key terms in the “Pipelines” section in the above example: Here are some key terms in the “Pipelines” section in the above example:
@@ -107,31 +111,35 @@ The "Job types" section will summarize which types of pipelines are being used a
The build steps summary section presents an overview of the individual build steps that are used across all pipelines and how many were automatically converted by Valet. The build steps summary section presents an overview of the individual build steps that are used across all pipelines and how many were automatically converted by Valet.
> Total: __17__ ```md
> ### Build steps
> Known: __13 (76%)__
> Total: **17**
> - echo: __6__
> - hudson.tasks.Shell: __3__ Known: **13 (76%)**
> - junit: __2__
> - archiveArtifacts: __1__ - echo: **6**
> - sh: __1__ - hudson.tasks.Shell: **3**
> - junit: **2**
> Unknown: __3 (17%)__ - archiveArtifacts: **1**
> - sh: **1**
> - sleep: __2__
> - hudson.plugins.git.GitPublisher: __1__ Unknown: **3 (17%)**
>
> Unsupported: __1 (5%)__ - sleep: **2**
> - hudson.plugins.git.GitPublisher: **1**
> - hudson.tasks.Mailer: __1__
> Unsupported: **1 (5%)**
> Actions: __22__
> - hudson.tasks.Mailer: **1**
> - run: __10__
> - actions/checkout@v2: __9__ Actions: **22**
> - EnricoMi/[email protected]: __2__
> - actions/upload-artifact@v2: __1__ - run: **10**
- actions/checkout@v2: **9**
- EnricoMi/[email protected]: **2**
- actions/upload-artifact@v2: **1**
```
Here are some key terms in the "Build steps" section in the above example: Here are some key terms in the "Build steps" section in the above example:
@@ -150,17 +158,21 @@ There is an equivalent breakdown of build triggers, environment variables, and o
The manual tasks summary section presents an overview of the manual tasks that you will need to perform that Valet is not able to complete automatically. The manual tasks summary section presents an overview of the manual tasks that you will need to perform that Valet is not able to complete automatically.
> Total: __9__ ```md
> ### Manual tasks
> Secrets: __2__
> Total: **9**
> - `${{ secrets.SECRET_TEST_EXPRESSION_VAR }}`: __1__
> - `${{ secrets.EXPRESSION_FIRST_VAR }}`: __1__ Secrets: **2**
>
> Self hosted runners: __7__ - `${{ secrets.SECRET_TEST_EXPRESSION_VAR }}`: **1**
> - `${{ secrets.EXPRESSION_FIRST_VAR }}`: **1**
> - `TeamARunner`: __6__
> - `DemoRunner`: __1__ Self hosted runners: **7**
- `TeamARunner`: **6**
- `DemoRunner`: **1**
```
Here are some key terms in the “Manual tasks” section in the above example: Here are some key terms in the “Manual tasks” section in the above example:
@@ -171,48 +183,50 @@ Here are some key terms in the “Manual tasks” section in the above example:
The final section of the audit report provides a manifest of all of the files that are written to disk during the audit. These files include: The final section of the audit report provides a manifest of all of the files that are written to disk during the audit. These files include:
> ### Successful ```md
> ### Successful
> #### demo_pipeline
> #### demo_pipeline
> - [demo_pipeline.yml](demo_pipeline.yml)
> - [demo_pipeline.config.json](demo_pipeline.config.json) - [demo_pipeline.yml](demo_pipeline.yml)
> - [demo_pipeline.jenkinsfile](demo_pipeline.jenkinsfile) - [demo_pipeline.config.json](demo_pipeline.config.json)
> - [demo_pipeline.jenkinsfile](demo_pipeline.jenkinsfile)
> #### monas_dev_work/monas_freestyle
> #### monas_dev_work/monas_freestyle
> - [monas_dev_work/monas_freestyle.yml](monas_dev_work/monas_freestyle.yml)
> - [monas_dev_work/monas_freestyle.config.json](monas_dev_work/monas_freestyle.config.json) - [monas_dev_work/monas_freestyle.yml](monas_dev_work/monas_freestyle.yml)
> - [monas_dev_work/monas_freestyle.config.json](monas_dev_work/monas_freestyle.config.json)
> #### test_mutlibranch_pipeline
> #### test_mutlibranch_pipeline
> - [test_mutlibranch_pipeline.config.json](test_mutlibranch_pipeline.config.json)
> - [test_mutlibranch_pipeline.config.json](test_mutlibranch_pipeline.config.json)
> ### Partially successful
> ### Partially successful
> #### monas_dev_work/monas_pipeline
> #### monas_dev_work/monas_pipeline
> - [monas_dev_work/monas_pipeline.yml](monas_dev_work/monas_pipeline.yml)
> - [monas_dev_work/monas_pipeline.config.json](monas_dev_work/monas_pipeline.config.json) - [monas_dev_work/monas_pipeline.yml](monas_dev_work/monas_pipeline.yml)
> - [monas_dev_work/monas_pipeline.jenkinsfile](monas_dev_work/monas_pipeline.jenkinsfile) - [monas_dev_work/monas_pipeline.config.json](monas_dev_work/monas_pipeline.config.json)
> - [monas_dev_work/monas_pipeline.jenkinsfile](monas_dev_work/monas_pipeline.jenkinsfile)
> #### test_freestyle_project
> #### test_freestyle_project
> - [test_freestyle_project.yml](test_freestyle_project.yml)
> - [test_freestyle_project.config.json](test_freestyle_project.config.json) - [test_freestyle_project.yml](test_freestyle_project.yml)
> - [test_freestyle_project.config.json](test_freestyle_project.config.json)
> #### test_pipeline
> #### test_pipeline
> - [test_pipeline.yml](test_pipeline.yml)
> - [test_pipeline.config.json](test_pipeline.config.json) - [test_pipeline.yml](test_pipeline.yml)
> - [test_pipeline.jenkinsfile](test_pipeline.jenkinsfile) - [test_pipeline.config.json](test_pipeline.config.json)
> - [test_pipeline.jenkinsfile](test_pipeline.jenkinsfile)
> ### Failed
> ### Failed
> #### groovy_script
> #### groovy_script
> - [groovy_script.error.txt](groovy_script.error.txt)
> - [groovy_script.config.json](groovy_script.config.json) - [groovy_script.error.txt](groovy_script.error.txt)
- [groovy_script.config.json](groovy_script.config.json)
```
Each pipeline will have a variety of files written that include: Each pipeline will have a variety of files written that include: