1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
Commit Graph

88 Commits

Author SHA1 Message Date
Florian Wilhelm
4295f7a24e
Restore alphabetical order of docs (#1643) 2020-06-09 09:05:28 +02:00
Florian Wilhelm
edef158e61
Document new npmExecuteScripts and mavenBuild steps (#1632) 2020-06-09 08:46:54 +02:00
Daniel Kurzynski
aa5566d8af
Add fortify docs (#1598)
Co-authored-by: Stephan Aßmus <stephan.assmus@sap.com>
2020-05-27 13:36:40 +02:00
Daniel Mieg
194d711e84
Adapt config for abapEnvironmentPullGitRepo, cloudFoundryCreateServiceKey and cloudFoundryDeleteService (#1520)
* Enable multiple repositories

* Improve readability

* Adapt documentation

* rerun generator

* Add initial info line

* Improve logging

* Enable configuration in GENERAL section

* Adapt yml abapEnvironmentPullGitRepo

* Add aliases for crendetialsId

* Change order of credentialsId aliases

* Change prio of different names of credentialsId

* Add docu to sidebar
2020-05-14 14:48:12 +02:00
Kevin Hudemann
d7985dd1b5
Enable use of customDefaults from Project Config also in Groovy (#1521)
This change enables the setupCommonPipelineEnvironment step to handle
custom default configurations defined in customDefaults parameter of the
project configuration.

Previously, only the getConfig Go step was able to incorporate custom
default configurations.

Update documentation on custom defaults and sharing between projects.

Co-authored-by: Stephan Aßmus <stephan.assmus@sap.com>
2020-05-12 13:50:18 +02:00
Marcus Holl
30850aec2d
Add groovy wrapper for malwarescanning (#1403) 2020-04-30 11:14:14 +02:00
Florian Wilhelm
ba086f1e9d
Bootstrap documentation for Piper-NG CLI/GH Action (#1448) 2020-04-28 09:28:34 +02:00
Arthur Lenz
b335387eac
feat(k8s): Add basic support for Helm 3 in kubernetesDeploy step (#1438)
* Extends kubernetesDeploy step to support Helm 3

Currently, the kubernetesDeploy step has no support to Helm 3 due to the fact that:
- the initialization command used works only for Helm 2
- the image used when running the helm CLI is based on Helm 2

The need for Helm 3 support comes from the fact that Helm 3 introduces major architectural changes,
more specifically, the removal of its server-side agent called Tiller - thus, being incompatible with
one another.

This commit adds this support by introducing a new configuration field (helmVersion).
By default, its values is set to 2 (Helm 2) to avoid breaking any existing functionalities.

* Use deployTool field to decide between Helm 2 or 3

* Remove helm init and replace wait for atomic in v3

* Update cmd/kubernetesDeploy.go

Nice catch!

Co-Authored-By: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>

* Add documentation for kubernetesDeploy step

* Add helm3 example for kubernetesDeploy step using mandatory fields

* Add new line at the end of kubernetesDeploy documentation

* Link kubernetesDeploy step with docs generator

* Add possible values for deployTool in kubernetesDeploy

* dummy change

* Revert "dummy change"

Co-authored-by: Oliver Nocon <33484802+OliverNocon@users.noreply.github.com>
Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>
2020-04-24 09:37:11 +02:00
Oliver Nocon
ef99f710ae
artifactPrepareVersion: documentation (#1365)
* artifactPrepareVersion: documentation

* Fix CodeClimate finding

* Update generated file

* Update versioning.yaml

* Update docs wrt PR 1374

* update generated step

* Update resources/metadata/versioning.yaml

Co-Authored-By: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>

* Update resources/metadata/versioning.yaml

Co-Authored-By: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>

* update generated file

Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>
2020-04-08 09:28:03 +02:00
Stephan Aßmus
7dbf3ba5bf
Generate documentation for nexusUpload (#1356) 2020-04-01 23:48:51 +02:00
Florian Geckeler
bb72c38413
Add documentation for mavenExecuteStaticCodeChecks groovy part (#1339)
* Add documentation for mavenExecuteStaticCodeChecks groovy part

* Add import

* Remove wrong default

* Add markdown file

* Add mkdocs

* Update vars/mavenExecuteStaticCodeChecks.groovy

Co-Authored-By: Daniel Kurzynski <daniel.kurzynski@sap.com>

* remove import

* remove import

Co-authored-by: Daniel Kurzynski <daniel.kurzynski@sap.com>
2020-03-31 11:29:44 +02:00
Marcus Holl
79475732f9
Upload to transport request scenario (#855)
Co-authored-by: Christoph Szymanski <spamerella@gmx.de>
Co-authored-by: SarahNoack <44202907+SarahNoack@users.noreply.github.com>
2020-02-21 16:16:15 +01:00
Florian Wilhelm
1b6781c1e9
Move docs of Cloud SDK Pipeline (#1167) 2020-02-18 17:51:44 +01:00
Oliver Nocon
d5bc8db50e
Add missing pages to documentation (#1172)
* Create spinnakerTriggerPipeline.md
* Update mkdocs.yml
2020-02-12 08:53:32 +01:00
dominiklendle
2007a94174
Add step cloudFoundryDeleteService (#1097) 2020-02-10 14:53:12 +01:00
RainerHimmeroeder
188686f5a7 add step materializeLogFile to jenkins library (#1046) 2019-12-16 21:09:25 +00:00
Thorsten Duda
7b6a7a051c
Merge branch 'master' into xsa-docu-patch 2019-12-13 09:00:43 +01:00
Stengel
7c1d0a742f Merge remote-tracking branch 'upstream/master' into J365 2019-12-12 11:02:10 +01:00
Thorsten Duda
04177c8b1a
Add XSA scenario in navigation 2019-12-12 08:16:22 +01:00
Stengel
cf53772af6 Change title of guided tour: PR800 once 2019-12-09 15:48:36 +01:00
Thorsten Duda
09bf1fef96
Merge branch 'master' into J365 2019-12-06 08:51:20 +01:00
Stengel
470c8e1eb1 PCDES-365 - Describe Piper usage without cx-server
integrate into guided tour/mkdocs
remove static plugin list
2019-12-02 14:53:34 +01:00
Daniel Mieg
2ad57f3d19 Add step cloudFoundryCreateServiceKey (#989) 2019-12-02 14:02:51 +01:00
Shanuson
77cd7e1025 Add link of step cloudFoundryCreateService to docu sidebar (#991) 2019-11-21 08:27:06 +01:00
Daniel Mieg
2e0bf3ac34 Add step to pull repository to ABAP in SAP Cloud Platform (#907) 2019-11-07 15:40:45 +01:00
Thorsten Duda
6604a82eb1 remove double scenarios entry 2019-10-28 16:47:57 +01:00
Thorsten Duda
800eeffeae remove double navigation entry 2019-10-28 13:56:11 +01:00
Marcus Holl
945599c109
docu xsdeploy scenario (#840) 2019-10-23 11:03:17 +02:00
Marcus Holl
61a91b5f25
Add containerPushToRegistry to docu index (#862) 2019-09-25 11:00:35 +02:00
Marcus Holl
96365d29f7
Add buildExecute to docu index. (#860) 2019-09-25 08:55:51 +02:00
Florian Wilhelm
e041f45183
Streamline documentation to reflect project "piper" (#875) 2019-09-19 14:17:41 +02:00
Sarah Noack
54cbc403c0 Add SAP Cloud Platform Transport Management scenario 2019-09-18 13:46:40 +02:00
Marcus Holl
e54f18e6bc
Introduce xsDeploy step (#749)
Introduce xs deploy
2019-09-11 13:42:38 +02:00
TheFonz2017
41dcebb3a5 Variable Substitution in YAML Files (#852)
* Changes:
- New YamlSubstituteVariables step to substitute variables in YAML files with values from another YAML
- New Tests, that check the different substitution patterns.
- Added test resources, including various manifest and variables files.
- Improved usage of JenkinsLoggingRule
- Improved JenkinsReadYamlRule to properly reflect the mocked library's behaviour.
- Added a new JenkinsWriteYamlRule.

* Changes:
- added a Logger that checks a config.verbose flag before it logs debug messages.
- changed error handling to rethrow Yaml parsing exception in case of wrongly-formatted Yaml files.
- changed JenkinsWriteYamlRule to capture Yaml file details of every invocation of writeYaml. This allows sanity checks at end of tests, even if there were multiple invocations.
- adjusted tests.

* Changes:
- Removed javadoc-code blocks from API documentation since they are not supported.
- Removed skipDeletion boolean.
- Added a new deleteFile script which deletes a file if present.
- Added a new JenkinsDeleteFileRule to mock deleteFile script and optionally skip deletion for tests.
- Adjusted yamlSubstituteVariables script.
- Adjusted tests to include new JenkinsDeleteFileRule.
- Changed code that deletes an already existing output file to produce better logs.

* Changes:
- Turned yamlSubstituteVariables into a script that works purely based on Yaml data (not files).
- Added a new cfManifestSubstituteVariables that uses yamlSubstituteVariables under the hood but works based on files.
- Adjusted tests, and added new ones.

* Adjusted documentation and a few log statements.

* Changed documentation to no longer include javadoc code statements.

* Made mocking of deletion of a file a default. Adjusted tests.

* Changed signature of yamlSubstituteVariables' call method to return void.

* Changes:
- Fixed naming issues in deleteFile.
- Renamed Logger to DebugHelper.
- Fixed some documentation.

* Changed implementation of deleteFile not to use java.io.File - which is evil when using it for file operations.

* PROPERLY Changed implementation of deleteFile not to use java.io.File - which is evil when using it for file operations.

* Changes:
- Added tests for deleteFile script
- Changed JenkinsFileExistsRule to also keep track of which files have been queried for existence.

* Changes:
- Removed java.io.File usage from cfManifestSubstituteVariables and using fileExists instead now.
- Adjusted tests.

* Wrapped file path inside ticks to allow spaces in file path when calling deleteFile.

* Removed null checks of mandatory parameters, and resorted to ConfigurationHelper.withMandatoryProperty

* Fixed a NullPointer due to weird Jenkins / Groovy behaviour.

* Changes:
- Turned yamlSubstituteVariables step into a utils class.
- Added tests
- Adjusted cfManifestSubstituteVariables to use utils class instead of step.
- Adjusted tests
- Adjusted APIs of DebugHelper.

* Re-introduced log statement that shows what variables are being replaced and with what.

* Changing API of YamlUtils to take the script and config as input.

* Test

* Test

* Test

* Test

* Test

* Fixing issue.

* Fixing issue.

* Changes:
- Refactored DebugHelper and YamlUtils to make usage nicer and rely on dependency injection.
- Removed Field for DebugHelper and turned it into local variable.
- Adjusted classes using the above.
- Adjusted tests where necessary.

* Added link to CF standards to YamlUtils also.

* Add docu for step cfManifestSubstituteVariables.md

* Added documentation.

* Added missing script parameter to documentation. Some steps document it, some don't. Right now you need it, so we document it.

* Fixed some layouting and typos

* Beautified exception listing.

* Removed trailing whitespaces to make code climate checks pass.

* Trying to get documentation generated, with all the exceptions to markup one should not use.

* cosmetics.

* cosmetics, part 2

* Code climate changes...

* Inlined deleteFile step.

* Added two more tests to properly check file deletion and output handling.

* Changes:
- adjusted API to take a list of variables files, as does 'cf push --vars-file'
- adjusted API to allow for an optional list of variable key-value-maps as does 'cf push --vars'
- reproduced conflict resolution and overriding behavior of variables files and vars lists
- adjusted tests and documentation

* Added missing paramter to doc comment.

* Re-checked docs for missing paramters or params that have no counterpart in the method signature.

* Adjusted documentation.

* Removed absolute path usage from documentation.

* corrected documentation.

* Changed javadoc comment to plain comment.

* Turned all comments to plain comments.
2019-09-06 10:20:35 +02:00
Marcus Holl
3d94ce4770
Add tmpUpload to mkdocs index page (#801) 2019-07-22 12:08:11 +02:00
Christopher Fenner
5bf7cda940
add new step piperPublishNotifications (#652)
* add new step for notification publication

* add test cases

* add helper method

* correct import

* Update pom.xml

* add step to post section

* add step piperPublishNotifications

* move step to end of pipeline to gather all findings

* use handlePipelineStepErrors step

* use commonPipelineEnvironment

* correct reporting

* add configuration

* fix typos

* fix rule setup

* remove test scope

* add method to fetch full build log

* add methods for warnings-ng parser creation

* remove warnings plugin coding

* add default parser settings

* change parameter handling for parser creation

* adapt step

* fix parser creation

* use ParserConfig.contains

* use correct parameter name

* correct parser regex

* change issue creation

* use classloader

* fix typo

* Revert "fix typo"

This reverts commit 446a201ae4.

* Revert "use classloader"

This reverts commit a896487032.

* rename step to piperPublishWarnings

* extract recordIssuesSettings to defaults

* make addWarningsNGParser non-static

* remove node

* adjust test case

* add docs

* rename log file

* fix tests

* fix typos

* rename parameter

* add import for IOUtils

* check plugin activation

* add comment for class loader usage
2019-07-18 12:09:54 +02:00
Oliver Nocon
225cf2485b
Docker Pipeline - fixes and small adoptions (#779)
* buildExecute: Docker case - minor fixes
* properly care for empty `containerBuildOptions`
* verbose output wrt stashing
* add stage ordinals
* fix wrong script reference
* fix null reference
* adapt stage defaults and allow bats tests
* propagate github org and repo
* add test for bats
2019-07-05 16:32:24 +02:00
Oliver Nocon
9e539e68ee
Piper pipeline - enhance stages (#755)
* fill PRVoting stage with content
* add prVoting stage incl. tests
* add Build stage incl. Tests
* add docs pages
* add additional unit test stage
* add acceptance stage and additional documentation ...
* add release stage content
* add promote stage
* add Security stage, fix defaults for Promote stage
* fix issue in doc generation
2019-07-03 10:13:26 +02:00
andre2007
36c029b344 Add dubExecute step (#754)
* Add dubExecute step
* Fix test
2019-06-19 16:52:18 +02:00
Marcus Holl
dfe5374221 Add kanikoExec to docu index (#714)
was missing in mkdocs.yml
2019-06-19 11:08:09 +02:00
Roland Stengel
2313a83dd6 Merge branch 'master' of github.com:SAP/jenkins-library into revdoc 2019-06-12 11:47:37 +02:00
Christopher Fenner
a6e11e7fd3
add HaDoLint to docs (#744) 2019-06-06 13:52:20 +02:00
Roland Stengel
5aa0a35934 Merge branch 'master' of github.com:SAP/jenkins-library into revdoc2 2019-05-23 09:33:32 +02:00
Roland Stengel
523f603071 review documentation
- clear separation of README.md from
  https://sap.github.io/jenkins-library/
- enhanced https://sap.github.io/jenkins-library/home
- introduction of guided tour
2019-05-23 09:21:41 +02:00
Christopher Fenner
c52d1ceb0d
add Sonar docs link (#704) 2019-05-14 10:59:52 +02:00
Oliver Nocon
729cd0ab30
detectExecuteScan - add doc to docs structure (#699) 2019-05-10 08:06:38 +02:00
Alejandra Ferreiro Vidal
e3dd6fd665 add new step docu to index 2019-04-17 16:28:45 +02:00
Christopher Fenner
39bc7b043c
Travis: use GHPages deploy provider (#645)
* remove GHDeploy script

* build MKDocs from docs folder

* use GHDeploy provider
2019-04-10 12:26:54 +02:00
Sven Merk
aaf969e0cf
Merge branch 'master' into whitesource-step 2019-03-29 11:01:15 +01:00
Alejandra Ferreiro Vidal
eba4c68a49 remove documentation 2019-03-29 08:44:36 +01:00