Document how to add custom sections to collapsibe job logs
Problem to solve
When we released collapsible job logs users like the feature and started asking if it's possible to generate custom collapsible sections.
We do support custom sections already, we only need to document.
Here is a user asking for the documentation https://gitlab.com/gitlab-org/gitlab-ce/issues/14664#note_184329440
Further details
Proposal
A section marker has the following format: [section_start|section_end]:<timestamp>:<section_name>\r\e[0K
Note that the ANSI code \r\e[0K
is necessary at the end of each section_start
or section_end
.
To create sequential sections:
section_start:1560896352:my_first_section\r\e[0KHeader of the 1st collapsible section
this line should be hidden when collapsed
this line too
section_end:1560896353:my_first_section\r\e[0K
section_start:1560896378:my_second_section\r\e[0KHeader of the 2nd collapsible section
this line should be hidden when collapsed
this line too
section_end:1560896390:my_second_section\r\e[0K
It's also possible to create custom nested sections:
section_start:1560896352:top_level_section\r\e[0KHeader of top level section
this line should be hidden when top level section is collapsed
section_start:1560896353:nested_section\r\e[0KHeader of nested section
this line should be hidden when top level or nested section is collapsed
this line also belongs to nested section
section_end:1560896378:nested_section\r\e[0K
this line also belongs to top level section
section_end:1560896390:top_level_section\r\e[0K