{"id":16514292,"url":"https://github.com/openwms/dtc-tasks","last_synced_at":"2026-03-06T01:42:42.739Z","repository":{"id":255488872,"uuid":"852237747","full_name":"openwms/dtc-tasks","owner":"openwms","description":"A collection of Groovy scripts and Gradle tasks to use with docToolchain","archived":false,"fork":false,"pushed_at":"2024-09-18T14:40:34.000Z","size":543,"stargazers_count":3,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-16T01:34:54.020Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openwms.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["openwms"],"patreon":"hscherrer"}},"created_at":"2024-09-04T13:17:26.000Z","updated_at":"2024-09-18T14:40:39.000Z","dependencies_parsed_at":"2024-09-05T19:10:11.445Z","dependency_job_id":null,"html_url":"https://github.com/openwms/dtc-tasks","commit_stats":null,"previous_names":["openwms/dtc-tasks"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/openwms/dtc-tasks","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openwms%2Fdtc-tasks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openwms%2Fdtc-tasks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openwms%2Fdtc-tasks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openwms%2Fdtc-tasks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openwms","download_url":"https://codeload.github.com/openwms/dtc-tasks/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openwms%2Fdtc-tasks/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30157889,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T22:39:40.138Z","status":"ssl_error","status_checked_at":"2026-03-05T22:39:24.771Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2024-10-11T16:12:05.883Z","updated_at":"2026-03-06T01:42:42.723Z","avatar_url":"https://github.com/openwms.png","language":null,"funding_links":["https://github.com/sponsors/openwms","https://patreon.com/hscherrer"],"categories":[],"sub_categories":[],"readme":"# Purpose\nThis repository is a collection of Groovy scripts and Gradle tasks that are used with [docToolchain](https://github.com/docToolchain/docToolchain)\nto import (_export_ Task) data from 3rd party datasource and publish transformed or generated content to data sinks.\n\nA combination of all task steps could look like\n![pipeline][0]\n\n\n# Requirements\nTested with:\n- dtcw 0.51\n- docToolchain 3.4.4\n- Java 17\n\n# Usage\nThe easiest way to use the tasks is to configure the additional custom task path in the `docToolchainConfig.groovy`:\n````\ncustomTasks = [\n  'scripts/convertToDocBook.gradle',\n  'scripts/convertToMarkdown.gradle',\n  'scripts/convertToMediawiki.gradle',\n  'scripts/exportGithubIssues.gradle',\n  'scripts/publishToMediawiki.gradle',\n  'scripts/publishToOpenProject.gradle',\n]\n````\n\n# GitHub Issue Exporter\nThe Gradle task `exportGithubIssues` can be used to connect to [GitHub.com](https://www.github.com) and retrieve issues from a repository.\nBecause it is an _export_ task it generates asciidoctor source files in the `src` folder that can then be embedded into other asciidoctor\ndocuments. The task searches for open and closed issues and creates three files if these issues exist: `allGitHubIssues.adoc`,\n`closedGitHubIssues.adoc` and `openGitHubIssues.adoc`.\n\nEmbedded into handwritten documentation this could look like:\n![githubissues][1]\n\n## Configure \u0026 Run\nBeside the registration of the task in the `customTasks` section a custom GitHub configuration needs to be added of the same file:\n````\ngithub = [:]\ngithub.with {\n    user = \"${System.getenv('GITHUB_USER')}\"\n    password = \"${System.getenv('GITHUB_PASSWORD')}\"\n    root = \"https://api.github.com/\"\n    organization = \"\u003cyour organization name\u003e\"\n    repository = \"\u003cyour repo name\u003e\"\n    resultsPerPage = 100\n}\n````\n\nAfter that you can call the wrapper like:\n````\n$ ./dtcw exportGithubIssues\n````\nto generate the snippets.\n\n# Docbook Converter\nThe Gradle task `convertToDocBook` is used to convert asciidoctor files into OASIS standardized Docbook (version 5.0) format. The task\nexpects source files in the DocToolchain `${srcDir}` folder (usually `./src`) and converts them into Docbook files, stored in the\nDocToolchain `${targetDir}/docbook` folder (usually `./build/docbook`}).\n\n| Asciidoctor (Source) | Docbook (Target) |\n|----------------------|------------------|\n| ![asciidoc][2]       | ![docbook][3]    |\n\nNotice: Images are not embedded (as base64 encoded data) and are file references in the output document, because further converters in the\nDocToolchain pipeline might convert images or not on their own.\n\n## Configure \u0026 Run\nBeside the registration of the task in the `customTasks` section no additional configuration is required to run the task:\n````\n$ ./dtcw convertToDocBook\n````\nto convert all asciidoctor files in `${srcDir}` into Docbook files in `${targetDir}/docbook`.\n\n# Markdown Converter\nExisting Docbook files can be converted into various formats, one of them is [Markdown](https://daringfireball.net/projects/markdown) that\nis used by a lot of wikis and online authoring tools. To achieve the conversion, the converter uses [pandoc](https://pandoc.org) to convert\nall files in `${targetDir}/docbook` to `${targetDir}/md`.\n\n| Docbook (Source) | Markdown (Target) |\n|------------------|-------------------|\n| ![docbook][3]    | ![markdown][4]    |\n\nNotice: When images in source documents come as file references, the output Markdown file will also refer to a file. If the image is \nembedded, then it is also embedded in Markdown format.\n\n## Configure \u0026 Run\nBeside the registration of the task in the `customTasks` section no additional configuration is required to run the task:\n````\n$ ./dtcw convertToMarkdown\n````\nto convert all Docbook files in `${targetDir}/docbook` into Markdown files in `${targetDir}/md`.\n\n# Mediawiki Converter\nExisting Docbook files can also be converted into [Mediawiki format](https://www.mediawiki.org). The converter is very similar to the\n[Markdown Converter][] and uses [pandoc](https://pandoc.org) to convert all files in `${targetDir}/docbook` to `${targetDir}/mw`.\n\n| Docbook (Source) | Mediawiki (Target) |\n|------------------|--------------------|\n| ![docbook][3]    | ![mediawiki][5]    |\n\nNotice: When images in source documents come as file references, the output Mediawiki file will also refer to a file. If the image is\nembedded, then it is also embedded in Mediawiki format.\n\n## Configure \u0026 Run\nBeside the registration of the task in the `customTasks` section no additional configuration is required to run the task:\n````\n$ ./dtcw convertToMediawiki\n````\nto convert all Docbook files in `${targetDir}/docbook` into Mediawiki files in `${targetDir}/mw`.\n\n# Publish to Mediawiki\nPreviously generated Mediawiki documents can be uploaded to a Mediawiki server using the existing Mediawiki web api. The gradle task to do\nso, wraps a [python script](https://github.com/SoerenKemmann/mediawiki-utils) (credits to [SoerenKemmann](https://github.com/SoerenKemmann))\nthat does the heavy lifting.\n\n![mediawikiserver][6]\n\n## Task Requirements\n- Python3 must be installed on the machine that is executing the task\n- [Python scripts](https://github.com/SoerenKemmann/mediawiki-utils) must be downloaded and placed under `${docDir}/bin`\n\n## Configure \u0026 Run\nBeside the registration of the task in the `customTasks` section, additional configuration is required to run the task:\n````\nmediawiki = [:]\nmediawiki.with {\n    api = \"\u003cyour mediawiki server\u003e/api.php\"\n    user = \"${System.getenv('MEDIAWIKI_USER')}\"\n    password = \"${System.getenv('MEDIAWIKI_PASSWORD')}\"\n    extension = \".mw\"\n    context = \"\u003cName of the context page to store all generated documentation\u003e\"\n    page = \"\u003cName of the page where the documentation shall be placed in\u003e\"\n}\n````\n\n````\n$ ./dtcw publishToMediawiki\n````\nto upload all previously generated files in `${targetDir}/mw` to the Mediawiki server.\n\n[0]: res/images/dtc-pipeline.drawio.png\n[1]: res/images/screenshot.png\n[2]: res/images/asciidoctor.png\n[3]: res/images/docbook.png\n[4]: res/images/markdown.png\n[5]: res/images/mediawiki.png\n[6]: res/images/mediawikiserver.png\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenwms%2Fdtc-tasks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenwms%2Fdtc-tasks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenwms%2Fdtc-tasks/lists"}