mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-01-20 05:19:40 +02:00
fix: markdownlint findings for MD012 (#2383)
* activate MD012 * activate MD012 * fix MD012 findings * fix MD012
This commit is contained in:
parent
70eab49cb7
commit
20fd6e82ff
@ -45,9 +45,6 @@ plugins:
|
||||
# https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md004
|
||||
MD004:
|
||||
enabled: false
|
||||
# https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md012
|
||||
MD012:
|
||||
enabled: false
|
||||
# https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md007
|
||||
MD007:
|
||||
enabled: false
|
||||
|
@ -7,7 +7,6 @@ MD033: false #no-inline-html
|
||||
# TODO: fix in separate PR
|
||||
MD001: false #heading-increment/header-increment
|
||||
MD004: false #ul-style
|
||||
MD012: false #no-multiple-blanks
|
||||
MD007: false #ul-indent
|
||||
MD022: false #blanks-around-headings/blanks-around-headers
|
||||
MD024: false #no-duplicate-heading/no-duplicate-header
|
||||
|
@ -27,7 +27,6 @@ Register to our [google group][google-group] in order to get updates or for aski
|
||||
Read and understand our [contribution guidelines][piper-library-contribution]
|
||||
before opening a pull request.
|
||||
|
||||
|
||||
[piper-library-user-doc]: https://sap.github.io/jenkins-library/
|
||||
[piper-library-issues]: https://github.com/SAP/jenkins-library/issues
|
||||
[piper-library-license]: ./LICENSE
|
||||
|
@ -71,7 +71,6 @@ return this
|
||||
By default, there is a possibility for extensions to get executed. In case of disabling it, please ensure to set `PIPER_DISABLE_EXTENSIONS` to `true`.
|
||||
Setting this parameter to `true` excludes the execution of extension files in `.pipeline/extensions/<StageName>.groovy`.
|
||||
|
||||
|
||||
### Practical example
|
||||
|
||||
For a more practical example, you can use extensions in the SAP Cloud SDK pipeline to add custom linters to your pipeline.
|
||||
|
@ -55,7 +55,6 @@ the API and are subjected to change without prior notice. Types and methods anno
|
||||
`@API` are considered to be API, used e.g. from other shared libraries. Changes to those
|
||||
methods/types needs to be announced, discussed and agreed.
|
||||
|
||||
|
||||
[github]: https://github.com
|
||||
[piper-library]: https://github.com/SAP/jenkins-library
|
||||
[cloud-sdk-pipeline]: pipelines/cloud-sdk/introduction/
|
||||
|
@ -7,7 +7,6 @@ Parameters that support being fetched from Vault are marked with the Vault Label
|
||||
|
||||
![Vault Label](../images/parameter-with-vault-support.png)
|
||||
|
||||
|
||||
## Vault Setup
|
||||
|
||||
The first step to store your pipeline secrets in vault, is to enable a the [Key-Value Engine](https://www.vaultproject.io/docs/secrets/kv/kv-v2). And then create a policy which grants read access to the key value engine.
|
||||
|
@ -26,7 +26,6 @@ This will generate a project which already includes a `Jenkinsfile`, and a `pipe
|
||||
For a limited amount of time starting with version v29 both locations can be used.
|
||||
In the following the configuration file is referenced by its new location.
|
||||
|
||||
|
||||
In case you already created your project without this option, you'll need to copy and paste two files into the root directory of your project, and commit them to your git repository:
|
||||
|
||||
* [`Jenkinsfile`](https://github.com/SAP/cloud-s4-sdk-pipeline/blob/master/archetype-resources/Jenkinsfile)
|
||||
|
@ -2,7 +2,6 @@
|
||||
|
||||
The pipeline consists of a sequence of stages where each contains a number of individual steps.
|
||||
|
||||
|
||||
### First step: Pull Request Pipeline
|
||||
|
||||
In order to validate pull-requests to your GitHub repository you need to perform two simple steps:
|
||||
@ -130,21 +129,18 @@ Default implementation will come soon ...
|
||||
|
||||
Currently custom logic can be added using the [stage extension mechanism](../extensibility.md).
|
||||
|
||||
|
||||
### Performance
|
||||
|
||||
Default implementation will come soon ...
|
||||
|
||||
Currently custom logic can be added using the [stage extension mechanism](../extensibility.md).
|
||||
|
||||
|
||||
### Compliance
|
||||
|
||||
Default implementation will come soon ...
|
||||
|
||||
Currently custom logic can be added using the [stage extension mechanism](../extensibility.md).
|
||||
|
||||
|
||||
### Confirm
|
||||
|
||||
The [Confirm stage](confirm.md), if executed, stops the pipeline execution and asks for manual confirmation before proceeding to the stages _Promote_ and _Release_.
|
||||
@ -155,7 +151,6 @@ Default implementation will come soon ...
|
||||
|
||||
Currently custom logic can be added using the [stage extension mechanism](../extensibility.md).
|
||||
|
||||
|
||||
### Release
|
||||
|
||||
Default implementation will come soon ...
|
||||
|
@ -24,7 +24,6 @@ abapEnvironmentCheckoutBranch script: this
|
||||
If you want to provide the host and credentials of the Communication Arrangement directly, the configuration could look as follows:
|
||||
|
||||
```yaml
|
||||
|
||||
steps:
|
||||
abapEnvironmentCloneGitRepo:
|
||||
repositoryName: '/DMO/GIT_REPOSITORY'
|
||||
@ -32,6 +31,7 @@ steps:
|
||||
abapCredentialsId: 'abapCredentialsId'
|
||||
host: '1234-abcd-5678-efgh-ijk.abap.eu10.hana.ondemand.com'
|
||||
```
|
||||
|
||||
Please note that the branchName parameter specifies the target branch you want to clone. Also keep in mind that the repositoryName parameter must define a single repository.
|
||||
|
||||
Another option is to read the host and credentials from the cloud foundry service key of the respective instance. Furthermore, if you want to clone multiple repositories, they can be specified in a configuration file.
|
||||
|
@ -42,7 +42,6 @@ steps:
|
||||
abapSystemSizeOfRuntime: 1
|
||||
```
|
||||
|
||||
|
||||
## Example: Configuration in the Jenkinsfile
|
||||
|
||||
The step, including all parameters, can also be called directly from the Jenkinsfile. In the following example, a configuration file is used.
|
||||
|
@ -5,4 +5,3 @@
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
|
@ -5,4 +5,3 @@
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
|
@ -5,4 +5,3 @@
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user