Package: ywh2bt
ywh2btywh2bt synchronizes your vulnerability reports from theYes We Hack platformwith issues of your bug tracker(s). It automatically retrieves reports you want to copy in your bug tracker,
creates the related issue, and syncs further updates between issues and reports.It comes with a handy GUI to set up and test the integration,
while completely controlling the information you allow to be synchronized from both side.Table of contentsUser GuideArchitectureRequirementsInstallationSupported trackersChangelogLocal developmentRequirementsInstallationUsageUpdating User GuideUser GuideA User Guide is available inPDFandHTMLformats.ArchitectureYWH2BT embeds both the GUI to set up the integration,
and the application to be scheduled on your server to periodically poll and synchronize new reports.You can either run both on a single machine, or prepare the configuration file
on a computer (with the GUI) and transfer it on the server and use it through a scheduled command.Since data is pulled from YWH platform to your server, only regular outbound web connections need to be authorized on your server.Requirementspython>=3.7,<=3.12pipSupported trackersgithubgitlabjira / jiracloudservicenowChangelogv2.8:improved Python versions support (>=3.7 to <=3.12)removed the GUI from the default installation (usepip install 'ywh2bt[gui]'to include the GUI)fixed an issue with github when the title of an issue is longer than 255 charactersfixed an issue with jira image previews when multiple attached images have the same namev2.7:added synchronization of "fix verification" logs when "Upload status updates" is checkedfixed an issue with jira when scope contains special markdown charactersfixed an issue when "Download bug trackers comments" feedback option is activated
and bug tracker attachments do not meet platform attachments requirements (unacceptable mime-type, maximum allowed size exceeded)fixed an issue with jira when the title of an issue is longer than 255 charactersv2.6:added work around bug trackers maximum size allowed for the text of the issues/comments (content put in Markdown file attachment when necessary)v2.5:added Personal Access Token (PAT) authenticationremoved OAuth authenticationv2.4:added option to prevent recreation of issues that were created by a previous synchronization
but are not found into the bug tracker anymorev2.3:added support for ServiceNowv2.2:added GitLab option for confidential issuesv2.1:added feedback feature (synchronize from bug tracker to report)addeddocker image yeswehack/ywh2bugtrackeradded User GuidePDFandHTMLv0.* to v2.0.0:behavior changes:reports logs can selectively be synchronized with the trackers:public commentsprivate commentsreport details changesreport status changesrewardsa program can now only be synchronized with 1 trackeradded support for JSON configuration filesremovedywh-bugtrackercommand (useywh2bt synchronize)addedywh2btcommand:addedywh2bt synchronize:note:ywh2bt synchronize --config-file FILE --config-format FORMATis the equivalent ofywh-bugtracker -n -f FILEin v0.*addedywh2bt validateaddedywh2bt testaddedywh2bt convertaddedywh2bt schemaremoved command line interactive modeadded GUI viaywh2bt-guicommandLocal developmentRequirementspoetry(pip install poetry)Installationmake install(orpoetry install): creates a virtualenv and install dependenciesmake install-with-gui(orpoetry install --extras=gui): creates a virtualenv and install dependencies, including the guiUsageInstead ofywh2bt [command], run commands usingpoetry run ywh2bt [command].Same goes forywh2bt-gui, runpoetry run ywh2bt-guiinstead.Updating User GuidePDFandHTMLversions of the User Guide are generated via Pandoc
usingdocs/User-Guide.mdas an input file.Any changes made todocs/User-Guide.mdmust be followedby the execution of the commandmake user-guidein order to regenerate the PDF and HTML files,otherwise the CI will fail.