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

363 Commits

Author SHA1 Message Date
OliverNocon
2fb260c32a extend documentation generation with custom defaults 2019-04-10 12:17:29 +02:00
Alejandra Ferreiro Vidal
0565b5e63f transportRequestCreate: generate docu 2019-04-09 22:12:21 +02:00
Alejandra Ferreiro Vidal
a179dc6e3d checksPublishResults: generate docu 2019-04-09 19:46:23 +02:00
Alejandra Ferreiro Vidal
97ec7d78de remove outdated docu 2019-04-09 18:48:39 +02:00
Alejandra Ferreiro Vidal
ea71736939 testsPublishResults: generate docu 2019-04-09 15:19:33 +02:00
Alejandra Ferreiro Vidal
2af1b7c365 setupCommonPipelineEnvironment: generate docu 2019-04-09 13:58:35 +02:00
Alejandra Ferreiro Vidal
938d251a58 pipelineRestartSteps: generate docu 2019-04-09 13:18:51 +02:00
Alejandra Ferreiro Vidal
7a54118b2a gaugeExecuteTests: generate docu 2019-04-09 11:59:08 +02:00
Alejandra Ferreiro Vidal
bde8f388be containerExecuteStructureTests: generate docu 2019-04-09 11:12:38 +02:00
Alejandra Ferreiro Vidal
fa05b0bcb6 prepareDefaultValues: generate docu (#634) 2019-04-09 09:52:45 +02:00
Alejandra Ferreiro Vidal
998dd99cf5 batsExecuteTests: generate docu (#605) 2019-04-09 08:39:20 +02:00
Christopher Fenner
5c13a0e2a2
fix docs generation (#643) 2019-04-05 15:31:29 +02:00
Sven Merk
2ad3483233
Merge branch 'master' into whitesource-step 2019-04-04 22:19:16 +02:00
Alejandra Ferreiro Vidal
1e36df6a9c fix docs generation (#640) 2019-04-04 17:01:30 +02:00
Sven Merk
259619f00f
Merge branch 'master' into whitesource-step 2019-04-04 16:06:51 +02:00
LukasHeimann
54846ea0d6 Add a guide on authenticating UIVeri5 tests (#577)
* Add a guide on authenticating UIVeri5 tests

* Update documentation/docs/steps/uiVeri5ExecuteTests.md

Co-Authored-By: LukasHeimann <48723560+LukasHeimann@users.noreply.github.com>
2019-04-04 13:54:16 +02:00
Alejandra Ferreiro Vidal
fbddb910d0 fix docu 2019-04-04 10:50:46 +02:00
Oliver Nocon
138656b49b
Allow resilient error handling in pipelines (#583)
* add resilience to error handling
* adapt documentation
* make ConfigLoader more resilient
2019-04-04 08:38:54 +02:00
Sven Merk
dfa47ac4c7
Merge branch 'master' into whitesource-step 2019-04-03 22:18:39 +02:00
Alejandra Ferreiro Vidal
316ea83423 fix doc build error 2019-04-03 15:44:59 +02:00
Sven Merk
1fe05b8a56
Merge branch 'master' into whitesource-step 2019-04-03 12:19:34 +02:00
Alejandra Ferreiro Vidal
83ee7d0b28 mtaBuild: generate docu 2019-04-03 10:36:56 +02:00
Alejandra Ferreiro Vidal
92e895d34e pipelineExecute: generate docu 2019-04-03 09:41:27 +02:00
Alejandra Ferreiro Vidal
d863bb3209 durationMeasure: generate config 2019-04-03 08:16:33 +02:00
Alejandra Ferreiro Vidal
3d0aa51380 mavenExecute: generate docu 2019-04-02 22:03:23 +02:00
Alejandra Ferreiro Vidal
0397f152dc
Merge branch 'master' into healthExecuteCheck 2019-04-02 21:01:29 +02:00
Alejandra Ferreiro Vidal
f77d9957a5 handlePipelineStepErrors: generate docu 2019-04-02 20:06:47 +02:00
Alejandra Ferreiro Vidal
4f93f1f07a healthExecuteCheck: generate docu 2019-04-01 11:14:38 +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
Marcus Holl
97c4ebf3dd provide the docu metadata as json 2019-03-27 17:21:08 +01:00
Sven Merk
da549bc2e6
Merge branch 'master' into whitesource-step 2019-03-27 14:36:37 +01:00
Sven Merk
6c85699689 Fix docu template 2019-03-27 11:57:48 +01:00
Oliver Nocon
27c4db47e4
Merge branch 'master' into whitesource-step 2019-03-26 16:46:45 +01:00
Marcus Holl
397ec0c2fc Prerequiste transportRequestCreate: SOLMAN ST720 SP08 or higher 2019-03-26 14:35:52 +01:00
Christopher Fenner
0e7ef41fab
newmanExecute: generate documentation (#591)
* generate docs for newmanExecute step

* fix typo
2019-03-26 13:26:21 +01:00
Christopher Fenner
f8c8e81958
generate docs for slackSendNotification step (#592) 2019-03-26 12:14:29 +01:00
Christopher Fenner
f138ae1499
mailSendNotification: generate documentation (#584) 2019-03-25 14:34:48 +01:00
Sven Merk
991dd5ec51
Merge branch 'master' into whitesource-step 2019-03-22 11:58:01 +01:00
Sven Merk
be814c62aa Included comments refactored docu generation 2019-03-21 13:25:22 +01:00
Irina Kirilova
90c0604471 sort parameters alphabetically 2019-03-21 10:44:42 +01:00
Irina Kirilova
a0eb77f3e6 update documentation for neoDeploy step parameters 2019-03-20 16:13:18 +01:00
Christopher Fenner
7177954e80
seleniumExecuteTests & uiVeri5ExecuteTests: improve documentation (#568)
* generate docs for seleniumExecuteTests

* inherit docs for uiVeri5ExecuteTests

* add description for failOnError
2019-03-19 15:38:52 +01:00
Daniel Kurzynski
af740e1092
Make source for neo deployments configurable in the config file (#564) 2019-03-18 14:55:51 +01:00
Christopher Fenner
7069f29ec5
snykExecute: add missing documentation (#570)
* add docs for snykExecute

* add link to new docs page
2019-03-18 11:08:41 +01:00
Marcus Holl
a1d8ea51f5 Merge remote-tracking branch 'github/master' into HEAD 2019-03-15 16:13:55 +01:00
Marcus Holl
bf48f18f3e take parameters keys into account again.
was removed since parameter keys does not appear anymore in the table denoting the
level where a parameter can be configured.

Nevertheless we need to take that parameter into account. We need to add the description for
that parameter, even if it cannot be configured on general or stage level.
2019-03-15 15:24:06 +01:00
Marcus Holl
52f3287cb3 Merge remote-tracking branch 'github/master' into HEAD 2019-03-15 15:01:12 +01:00
Marcus Holl
d8159e70d0 Adjust docu for npmExecute wrt docu generation 2019-03-15 14:14:15 +01:00
Marcus Holl
9a75c4a728 Update docu for neoDeploy: neo.sh needs to be contained in path 2019-03-15 08:23:47 +01:00
Sven Merk
c96f73866a Refactored to generally migrate config to deep structure 2019-03-14 15:18:01 +01:00
Marcus Holl
721aae4a8b configure docu generation for karmaExecuteTests 2019-03-14 14:01:48 +01:00
Marcus Holl
ad467a6ead Merge remote-tracking branch 'github/master' into HEAD 2019-03-14 13:21:19 +01:00
Marcus Holl
513ceee8cf
Merge branch 'master' into pr/fixStageDoc 2019-03-13 12:39:59 +01:00
Sven Merk
f2c7265986
Merge branch 'master' into whitesource-step 2019-03-13 12:13:16 +01:00
Christopher Fenner
6d7205377c generate karma docs (#555) 2019-03-13 12:01:05 +01:00
Sven Merk
6764e75551
Merge branch 'master' into whitesource-step 2019-03-13 10:43:23 +01:00
Sven Merk
0280fe56a9 Fix typo 2019-03-13 10:29:25 +01:00
Christopher Fenner
57911a5835
Merge branch 'master' into pr/fixStageDoc 2019-03-12 11:26:42 +01:00
Oliver Nocon
857bd2794a
uiVeri5ExecuteTests, documentation update (#545) 2019-03-11 17:27:37 +01:00
Sven Merk
4ae6675824 Revise docs 2019-03-08 13:56:07 +01:00
Sven Merk
6b61bc1b98 Updated documentation 2019-03-08 12:33:31 +01:00
Sven Merk
bfbee88620 Added documentation of parameters and step 2019-03-06 15:08:42 +01:00
yemengsap
38c5a0d779 Add npmExecute step (#491) 2019-02-21 19:14:48 +01:00
Florian Wilhelm
ada3ed909d
Don't print messages in all uppercase letters (#531) 2019-02-21 15:46:17 +01:00
weloli
47ba7ff035 reduce redunadancy in md files for doc generation 2019-02-18 08:20:16 +01:00
Florian Wilhelm
d2b6be4e25
Configure default mta build image to ppiper/mta-archive-builder (#515) 2019-02-15 13:48:34 +01:00
weloli
08edf94bd0 Merge branch 'master' of https://github.com/weloli/jenkins-library into pr/fixStageDoc 2019-02-15 09:31:28 +01:00
Oliver Nocon
793df723cf add step slackSendNotification (#338)
* add step slackSendNotification

This step allows to send Slack notifications in case of pipeline failures.

* add SWA reporting

* remove allowBuildFailure

* add GENERAL_CONFIG_KEYS

* update STEP_NAME

* add missing import

* fix MD findings

* adjust rule name to be aligned with #455
2019-02-13 16:45:35 +01:00
weloli
72adaf3dd5 Merge branch 'master' of https://github.com/weloli/jenkins-library into pr/fixStageDoc 2019-02-13 14:35:56 +01:00
weloli
0d0fe3a2a8 fix according to last agreement 2019-02-13 14:29:05 +01:00
SarahNoack
26ba407e9c Doc: Change size of figure title (#504) 2019-02-11 08:57:31 +01:00
weloli
184613a78b Merge branch 'master' of https://github.com/weloli/jenkins-library into pr/fixStageDoc 2019-02-08 16:09:41 +01:00
SarahNoack
f42b2502da Add CAP Scenario in Navigation (#502) 2019-02-08 15:45:24 +01:00
Christoph Szymanski
0402811f2f
Merge branch 'master' into CAP_Scenario 2019-02-08 14:23:36 +01:00
SarahNoack
04c0316983
Remove ", buildTarget:'CF'"
Remove ", buildTarget:'CF'" from  Jenkinsfile example
2019-02-08 13:51:41 +01:00
SarahNoack
a5597a447c
Add SAP CP to CF account 2019-02-08 13:48:09 +01:00
SarahNoack
5d0daafe00
Remove note
Exchange note that this is a basic scenario with a single sentence in the paragraph before
2019-02-08 13:43:33 +01:00
Christoph Szymanski
40ff8fa2e3
Build Target from Parameter to Configuration
as discussed with @marcusholl
2019-02-08 13:09:30 +01:00
Christopher Fenner
d657f0dc28
testsPublishResults: add option to fail the build on test errors (#472)
* add option to fail the build on test errors

* fix typo

* add test cases

* adjust docs

* set build result

* add hasTestFailure utils method

* use utils method

* use dedicated type

* adapt tests

* handle missing test actions

* Update testsPublishResults.md

* Update JenkinsUtils.groovy

* Update JenkinsUtils.groovy

* Update JenkinsUtils.groovy

* remove comments

* adapt test case

* Update TestsPublishResultsTest.groovy
2019-02-08 12:30:59 +01:00
Christopher Fenner
3f12015364
dockerExecuteOnKubernetes: generate documentation (#487)
* fix whitespace

* correct key order

* add docs annotation

* add key documentation

* remove generated documentation

* fix code climate finding
2019-02-08 12:20:45 +01:00
Marcus Holl
3a8bd80f09 fix: table not generated by mkdocs due to wrong syntax (#498) 2019-02-08 11:35:58 +01:00
Marcus Holl
df90255739 publish docu for step uiVeri5ExecuteTests (#499) 2019-02-08 11:15:32 +01:00
weloli
35e14f9667 fix stage definition 2019-02-08 10:10:02 +01:00
SarahNoack
b186e95dec
Fix another code climate issue 2019-02-07 16:44:04 +01:00
SarahNoack
ed99ac6bf7
Fix code climate issues 2019-02-07 16:42:18 +01:00
SarahNoack
214bc7a7c3
Make minor linguistic changes 2019-02-07 16:33:33 +01:00
SarahNoack
287eab8fae
Rework scenario 2019-02-07 16:16:10 +01:00
Noack
8e99bd4c63 Add CAP scenario 2019-02-07 13:57:57 +01:00
SarahNoack
d0f547861c
Merge branch 'master' into SarahNoack-patch-1 2019-02-06 14:25:01 +01:00
SarahNoack
005f0c824e
Fix training space 2019-02-06 14:06:03 +01:00
SarahNoack
ea34ebd847
Merge branch 'master' into SarahNoack-patch-2 2019-02-06 14:01:24 +01:00
SarahNoack
588ab54b8d
Change links to scenario files 2019-02-06 11:29:59 +01:00
SarahNoack
d2252c0eaf
Adapt scenario so that it matches the template
Adapt scenario title, add figure title, and minor linguistic and layout changes
2019-02-06 11:06:00 +01:00
Christopher Fenner
887c8d0186
Merge branch 'master' into pr/seeAnnotationInDocu 2019-02-06 10:07:57 +01:00
Christoph Szymanski
2f2131b56b
Merge branch 'master' into SarahNoack-patch-1 2019-02-06 09:12:52 +01:00
Marcus Holl
1b202f879a Provide flag for skipping docker image pulls (#407)
* Provide flag for skipping docker image pulls

Usefull for testing while developing images. Without pulling images it is possible to
use images available in the local registry only.
2019-02-06 08:48:33 +01:00
Christoph Szymanski
139ed7b15d Align Navigation Text with Header 2019-02-05 18:46:27 +01:00
SarahNoack
47fc15f2e3
Change title and add parameters
Change title to be consistent with other scenarios and add links to detailed description of the parameters used in this scenario.
2019-02-05 16:58:29 +01:00
Marcus Holl
34b7c24faf Merge remote-tracking branch 'github/master' into HEAD 2019-02-05 16:37:49 +01:00
Christopher Fenner
08d62eb303
Merge branch 'master' into pr/seeAnnotationInDocu 2019-02-04 14:39:00 +01:00
Christopher Fenner
d91fa6d29d
Merge branch 'master' into pr/allowSingleLineDocuComments 2019-02-04 14:38:22 +01:00
Christopher Fenner
bd32367c31
dockerExecute: generate docs (#480)
* correct key order

* add docs annotation and description

* describe parameters

* remove generated content from doc

* fix indent

* add further decumentations
2019-02-04 14:35:44 +01:00
Marcus Holl
22340ebb25 allow single line comments
like this /** short comment */
rather than
/**
  * short comment
  */
2019-02-04 12:41:38 +01:00
Marcus Holl
89fd30e84c implement @see strategy
in case there is a pseudo annotation '@see' found in a step docu the docu is retrived from
the parameter with the same name in the other step. Format is:

'@see <OTHER_STEP_NAME>'

This simplifies documentation for parameters with same name and same
semantics used in more than one step.
2019-02-01 16:59:54 +01:00
Oliver Nocon
3b2e42c74f
Add step containerExecuteStructureTest (#441)
* add step containerExecuteStructureTest
* include PR-review feedback
* documentation
2019-01-31 09:39:13 +01:00
Christopher Fenner
bca5b8ccf1
Add step uiVeri5ExecuteTests (#469)
* add defaults for uiVeri5 step

* add step and tests

* correct parameter names

* add empty docs

* add docs annotations

* remove not needed parameter

* add docs annotations
2019-01-31 09:16:34 +01:00
Marcus Holl
50edac02ca First char after docu asterisk is pruned
... with a blank after the asterisk the docu looks more beautifyfull.
2019-01-29 17:30:26 +01:00
Marcus Holl
8fb7c85e99 keep leading blanks in order to render 'git diff! Note' statements 2019-01-29 17:30:25 +01:00
Daniel Kurzynski
6e26d78047
Improve neo deploy (#440)
The following features were added:
Lock resources for deployment
New parameters: environment, vmArguments
Assert password does not start with @
Link to cloud cockpit
Only execute rolling update if app is running
Show logs if deployment failed
Restart app after normal deployment
Use neo namespace for parameters
Align parameter names with neo sdk: size, application, source
Remove vmSize check as done by the tool itself
2019-01-28 11:32:24 +01:00
Marcus Holl
ee58859cd9 Doc: Fix transportRequestCreate docu (transportRequestId) (#467) 2019-01-28 10:25:36 +01:00
SarahNoack
e9a9ae4a1a Refine Hybrid Development Documentation (#462) 2019-01-25 18:15:30 +01:00
Oliver Nocon
27c3891685
deployToCloudFoundry - patch mta blue-green deployment (#457)
mta deploy plugin has flag:
` --no-confirm` which is described as _"Do not require confirmation for deleting the previously deployed MTA apps"_

This flag is essentials for performing fully automated blue-green deployments.
2019-01-22 16:13:59 +01:00
SarahNoack
e452f79368 Doc: Add Image to SolMan Scenario (#453) 2019-01-18 17:42:32 +01:00
SarahNoack
c7564a6a99 Doc: Changed Heading for UI5 Scenario (#438) 2019-01-18 09:29:50 +01:00
SarahNoack
1f96a34f55 Update changeManagement.md (#437) 2019-01-18 09:23:00 +01:00
Christopher Fenner
4f804f8876 remove trailing line breaks 2019-01-18 08:57:54 +01:00
Marcus Holl
6f59627551 Create file containing classpath into build dir
and not into project root. With this appraoch the root folder get not
filled with temporary content.
2019-01-18 08:57:54 +01:00
Marcus Holl
760137058c Evaluate @GenerateDocumentation annotation. 2019-01-18 08:57:54 +01:00
Marcus Holl
f81dc7b147 docu script classpath contains the built classes folder
we do not have only groovy script, but also java files inside src folder.
Hence we should rely on the target/classes folder in order to see also the
compiled java classes, and not only the groovy scripts.
2019-01-18 08:57:54 +01:00
Marcus Holl
daaac272d6 Remove commented coding line 2019-01-18 08:57:54 +01:00
Marcus Holl
c6500a7516 Relocate script files for generting documention 2019-01-18 08:57:54 +01:00
Marcus Holl
96d5184651 Remove hand crafted step descrption 2019-01-18 08:57:54 +01:00
Marcus Holl
ab83e9f7b8 Generate docu during travis build (for checkChangeInDevelopment) 2019-01-18 08:57:54 +01:00
Marcus Holl
1ef91ce8a3 Parameters now generated during build 2019-01-18 08:57:54 +01:00
Oliver Nocon
e11478ca00
cloudFoundryDeploy - add deployment reporting to Influx (#421)
Add reporting of operations-related data to Influx (if configured), like:
* Version of deployed artifact
* Deployment time
* Target infrastructure for deployment
2019-01-18 08:25:22 +01:00
Oliver Nocon
98139bb498
influxWriteData - support Influx tags (#420)
* influxWriteData - support Influx tags

In order to better query data in Influx, tags needs to be written.
This change allows filling tag data via the Influx plugin.
2019-01-17 15:42:03 +01:00
weloli
4e20f61dc4 fix documentation 2019-01-17 12:36:13 +01:00
SarahNoack
4803695185 Documentation: Hybrid Applications with Jenkins and SAP Solution Manager (#410) 2019-01-15 17:45:26 +01:00
Marcus Holl
db5022a4ff New Scenario Step: SAP UI5 on SAP Cloud Platform (#388)
This scenario builds a UI5 app and deploys it to SAP Cloud Platform (neo).
2019-01-15 13:32:01 +01:00
Oliver Nocon
20a54cf094
dockerExecute - extend Kubernetes capabilities (#432)
allow `dockerExecute` to pass on to dockerExecuteOnKubernetes
* containerCommand
* containerShell
2019-01-14 14:43:07 +01:00
Christopher Fenner
3cb70a2a48 clean influx docs (#431) 2019-01-11 16:40:31 +01:00
Christopher Fenner
caf54b0e68 docs: add reference to newman page (#430) 2019-01-11 08:02:30 +01:00
Oliver Nocon
724a851bcd
executeDockerOnKubernetes - specify custom shell (#428)
Depending on the Docker image used the default shell will not work in certain cases.
This extends the executeDockerOnKubernetes step to be able to use a custom shell according to https://github.com/jenkinsci/kubernetes-plugin#specifying-a-different-shell-command-other-than-binsh
2019-01-08 19:44:28 +01:00
Christoph Szymanski
9157ad3ce6
Typo in documentation 2018-12-14 18:29:02 +01:00
Christoph Szymanski
30d6f59b56
Typo in documentation (#414) 2018-12-14 18:10:11 +01:00
Christopher Fenner
d303e49ebe
add newman doc (#399) 2018-12-10 11:53:48 +01:00
Marcus Holl
cc971190c9 Merge remote-tracking branch 'github/master' into HEAD 2018-12-07 13:04:51 +01:00
Marcus Holl
987584a28f Remove return value from docu for step checkChangeInDevelopment 2018-12-07 13:04:40 +01:00
Marcus Holl
b64a98ab5e Merge remote-tracking branch 'github/master' into HEAD 2018-12-06 16:13:44 +01:00
Oliver Nocon
74193bd98d
Documentation Update - streamline library alias (#402)
Change name to how vast majority of current users is using it.

Library alias can also be defined differently by users. Then `@Library` statement just needs to reflect the different name.
2018-12-05 13:37:15 +01:00
Florian Geckeler
32e20a7293
Provide option to Stop and not delete old instance on BlueGreenDeploy (#394)
* Provide option to Stop and not delete old instance on BlueGreenDeploy
* Default is still delete old instance 

Closes #323
2018-11-27 11:47:44 +01:00
Christopher Fenner
ddc40044a2
karmaExecuteTests: extend default proxy excludes and stashes (#389)
* extend default proxy excludes

* Update karmaExecuteTests.md
2018-11-19 10:54:14 +01:00
Oliver Nocon
d65a010158
testsPublishResults: Make jUnit pattern more universal (#386)
* Make jUnit pattern more universal
* update documentation & test
2018-11-16 08:57:09 +01:00
Marcus Holl
7446b1e93d Remove return value from step documentation
In the meantime the steps do not have a return value anymore.
2018-11-09 16:09:29 +01:00
Marcus Holl
8e7352cdb4 Adjust docu
there is no return value anymore.
2018-11-08 16:05:35 +01:00
Christopher Fenner
9a1ab37c0b
add new step karmaExecuteTests (#351)
* add new step for karma execution

* add defaults

* Update karmaExecuteTests.groovy

* add key comments

* add test case

* docs

* add step docs

* add step docs

* Update karmaExecuteTests.md

* complete docs

* Update karmaExecuteTests.md

* init `script` the "new way"

* Update karmaExecuteTests.groovy

* Update karmaExecuteTests.groovy
2018-11-08 12:15:15 +01:00
Christopher Fenner
f757a0e1d4
fix Markdown issues (#365)
* fix Markdown issue 'Headers should be surrounded by blank lines'

* fix MD012

* fix MD022

* fix MD026

* fix MD007

* fix MD032

* fix MD038

* fix MD040

* fix MD031

* fix MD034

* fix MD004

* fix new findings

* fix MD036

* fix MD038

* fix MD032

* fix MD006
2018-11-06 13:50:09 +01:00
Marcus Holl
bbfc973aaa Fix codeclimate remarks 2018-11-05 13:33:25 +01:00
Marcus Holl
3cb958b740 Merge remote-tracking branch 'github/master' into HEAD 2018-11-05 13:30:43 +01:00