{"id":14008402,"url":"https://github.com/jenkinsci/collapsing-console-sections-plugin","last_synced_at":"2025-03-24T04:31:34.351Z","repository":{"id":1231221,"uuid":"1163468","full_name":"jenkinsci/collapsing-console-sections-plugin","owner":"jenkinsci","description":"Jenkins collapsing-console-sections plugin","archived":false,"fork":false,"pushed_at":"2025-03-17T23:48:27.000Z","size":259,"stargazers_count":12,"open_issues_count":3,"forks_count":23,"subscribers_count":98,"default_branch":"master","last_synced_at":"2025-03-19T02:11:25.119Z","etag":null,"topics":["adopt-this-plugin","console","console-visualization","jenkins-plugin"],"latest_commit_sha":null,"homepage":"https://plugins.jenkins.io/collapsing-console-sections","language":"Java","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"Eonblast/Emysql","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jenkinsci.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2010-12-13T05:27:27.000Z","updated_at":"2025-02-24T10:23:48.000Z","dependencies_parsed_at":"2025-02-24T11:37:22.336Z","dependency_job_id":null,"html_url":"https://github.com/jenkinsci/collapsing-console-sections-plugin","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fcollapsing-console-sections-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fcollapsing-console-sections-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fcollapsing-console-sections-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fcollapsing-console-sections-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jenkinsci","download_url":"https://codeload.github.com/jenkinsci/collapsing-console-sections-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245211233,"owners_count":20578374,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adopt-this-plugin","console","console-visualization","jenkins-plugin"],"created_at":"2024-08-10T11:01:38.895Z","updated_at":"2025-03-24T04:31:34.076Z","avatar_url":"https://github.com/jenkinsci.png","language":"Java","funding_links":[],"categories":["Java"],"sub_categories":[],"readme":"# Collapsing Console Sections Plugin for Jenkins\n\n[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/collapsing-console-sections.svg)](https://plugins.jenkins.io/collapsing-console-sections)\n[![GitHub release](https://img.shields.io/github/release/jenkinsci/collapsing-console-sections-plugin.svg?label=changelog)](https://github.com/jenkinsci/collapsing-console-sections-plugin/releases/latest)\n[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/collapsing-console-sections.svg?color=blue)](https://plugins.jenkins.io/collapsing-console-sections)\n\nThis plugin allows the creation of sections in build consoles.\nThese sections can be individually collapsed to hide unimportant details.\nA floating outline widget is available to navigate through all the sections of a build.\n\n## Basic Usage\n\nOnce this plugin is installed, you can define console sections from _Manage Jenkins \u003e System Configuration \u003e Configure System_.\n\nEach console section is defined by a display name, a Java regular expression pattern that identifies the start of the section in log files, and a second regex that identifies the end of the section.\n\nStarting with version `1.2` of this plugin, captured groups from the start-of-section regular expression can be referenced from the section display name.\nSimply use {`1`}, {`2`}, and so forth in the place where you want to insert the value of the corresponding capture group of the regular expression.\n\n![](docs/images/collapsing-console-config.png)\n\nIn the below example an text following the occurance of the word `STARTING ` in the logs will be used as the Section Name. \n\n![](docs/images/wilcard-reference-config.png)\n\nAfter console sections have been defined, any section definition that matches contents of a visited build console URL will cause the that section to be annotated in the browser window.\nVisibility of the section contents can be toggled with the _Hide/Show_ link.\n\n![](docs/images/console-sections.png)\n\nA floating navigation widget is also inserted into the left-side navigation to aid movement between console sections.\n\n![](docs/images/navigation.png)\n\n## Programmatic Usage\n\nIf you want to provide a pre-canned set of sections for your organization's Jenkins installation,\nyou can create a plugin that depends on this plugin, and programmatically create section definitions.\nCreate instances of `SectionDefinition` to define sections, and then create a `ConsoleAnnotatorFactory` subclass that returns an instance of\n`CollapsingSectionAnnotator`.\nHere is a simple example that creates a section around Subversion checkouts.\n\n``` java\nimport hudson.Extension;\nimport hudson.console.ConsoleAnnotator;\nimport hudson.console.ConsoleAnnotatorFactory;\nimport hudson.model.Run;\nimport org.jvnet.hudson.plugins.collapsingconsolesections.CollapsingSectionAnnotator;\nimport org.jvnet.hudson.plugins.collapsingconsolesections.SectionDefinition;\n\n\n@Extension\npublic class SubversionAnnotatorFactory extends ConsoleAnnotatorFactory\u003cClass\u003cRun\u003e\u003e {\n    @Override\n    public ConsoleAnnotator newInstance(Class\u003cRun\u003e context) {\n        SectionDefinition svnSection = new SectionDefinition( \"Subversion Checkout\",\n                \"((Checking out)|(Updating) (http|https|svn\\\\+ssh).+\",\n                \"At revision \\\\d+.+\" );\n        return new CollapsingSectionAnnotator( svnSection );\n}\n```\n\nThe signature for `CollapsingSectionAnnotator`'s constructor is\n\n``` java\npublic CollapsingSectionAnnotator( SectionDefinition... definitions );\n```\n\nSo you can use a single annotator that defines multiple console sections.\n\n## Changelog\n\n* For recent versions, see [GitHub releases](https://github.com/jenkinsci/collapsing-console-sections-plugin/releases)\n* For versions `1.7.0` and before, see the [changelog archive](docs/OLD_CHANGELOG.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fcollapsing-console-sections-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjenkinsci%2Fcollapsing-console-sections-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fcollapsing-console-sections-plugin/lists"}