Skip to content

Commit 405ded7

Browse files
committed
CT-143 added global vars documentation in README
1 parent d756370 commit 405ded7

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,14 @@ Alternatively, you can check out this example demo project which shows some use
4747
A lot of the configuration for external systems (Github, SonarQube etc) are set in the `Constants.groovy` constants class.
4848
You can edit this to match according to your settings.
4949

50+
### Gloval Vars Documentation
51+
52+
Each of the global variables (helper functions) has its own documentation (corresponding *.txt file). You can access these documentation on the __Global Variable Reference__ link on the navigation sidebar of pipeline jobs that imported this shared library.
53+
54+
Note that as per Jenkins documentation this is only visible after one successful run of the pipeline job for the documentation to be generated.
55+
56+
The documentation is in (.txt) file format and contains HTML.
57+
5058
## Release Notes
5159

5260
__v0.0.1__

0 commit comments

Comments
 (0)