{"id":17320960,"url":"https://github.com/tom-tan/cwl-template-for-vscode","last_synced_at":"2025-04-13T12:43:22.136Z","repository":{"id":55981549,"uuid":"206332605","full_name":"tom-tan/cwl-template-for-vscode","owner":"tom-tan","description":"A template to write CWL documents with VSCode with remote container extension","archived":false,"fork":false,"pushed_at":"2024-08-29T06:12:29.000Z","size":58,"stargazers_count":8,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-27T03:41:42.842Z","etag":null,"topics":["common-workflow-language","commonwl","cwl","template","vscode"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tom-tan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2019-09-04T13:59:56.000Z","updated_at":"2024-12-03T05:45:01.000Z","dependencies_parsed_at":"2024-06-01T16:28:24.194Z","dependency_job_id":"b37003c4-b305-45fb-9ab1-6f477a2370e1","html_url":"https://github.com/tom-tan/cwl-template-for-vscode","commit_stats":null,"previous_names":["tom-tan/cwl-template-for-vscode"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tom-tan%2Fcwl-template-for-vscode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tom-tan%2Fcwl-template-for-vscode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tom-tan%2Fcwl-template-for-vscode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tom-tan%2Fcwl-template-for-vscode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tom-tan","download_url":"https://codeload.github.com/tom-tan/cwl-template-for-vscode/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248717234,"owners_count":21150387,"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":["common-workflow-language","commonwl","cwl","template","vscode"],"created_at":"2024-10-15T13:34:27.197Z","updated_at":"2025-04-13T12:43:22.113Z","avatar_url":"https://github.com/tom-tan.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# What is this?\nThis is a template to write CWL documents with VSCode with remote container extension.\n\n[![Actions Status](https://github.com/tom-tan/cwl-template-for-vscode/workflows/CI/badge.svg)](https://github.com/tom-tan/cwl-template-for-vscode/actions) [![CircleCI](https://circleci.com/gh/tom-tan/cwl-for-remote-container-template/tree/master.svg?style=shield)](https://circleci.com/gh/tom-tan/cwl-for-remote-container-template/tree/master) [![pipeline status](https://gitlab.com/tom-tan/cwl-for-remote-container-template/badges/master/pipeline.svg)](https://gitlab.com/tom-tan/cwl-for-remote-container-template/commits/master)\n\n## Requirements\n- [Visual Studio Code](https://code.visualstudio.com/)\n- [Remote - Container extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)\n- git\n- Docker\n\n## How to use\n- Push the `Use this template` button in this repository and create a new repository for you,\n- Clone it to your local machine, and\n- Open the cloned repository with remote container extension of VSCode.\n- Have fun!\n\n## What is provided by this template?\n- A container setting for VSCode. It provides the followings:\n  - basic tools such as `cwltool`, `cwl-runner`, `cwltest` and `nodejs` (for `InlineJavascriptRequirement`)\n  - `docker` (you can use it without any configurations)\n  - [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) and [zatsu-cwl-generator](https://github.com/tom-tan/zatsu-cwl-generator) to help writing CWL documents\n  - [Live Share extension](https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare) for live coding\n- A template for `cwltest`\n- Templates for CI services (described below)\n\n## How to run tests\n\n- Edit `test.yml`\n  - Each entry consists of the input CWL file in `tool` field, the input parameter file in `job` field and the expected output object in `output` field (`doc` field is optional).\n  - Here is an example entry:\n  ```yaml\n  - job: job/cat-job.yml\n    tool: cwl/cat.cwl\n    output:\n      out:\n        class: File\n        basename: output.txt\n        checksum: sha1$2af1a59da667eb4aedb182248c1d91741df7e24d\n        size: 31\n    doc: Template for cwltest\n  ```\n  - You can add new entries for your tools and workflows. I assume that the CWL files are put in `cwl` directory, the input parameter files are put in `job` directory, and the example inputs are put in `data` directory.\n- Run test with the following command\n  ```console\n  $ cwltest --test test.yml\n  Test [1/1] Template for cwltest\n  ...\n  All tests passed\n  ```\n\n## Supported CI services\nThis template provides configurations for several CI services.\nAll you have to do is just integrating your repository with CI services.\nEach CI service executes tests listed in `test.yml` by using `cwltest`.\n\nReplace `$USER` with your account name and `$REPO` with your repository name.\n- Github Actions [![Actions Status](https://github.com/tom-tan/cwl-template-for-vscode/workflows/CI/badge.svg)](https://github.com/tom-tan/cwl-template-for-vscode/actions)\n  - Replace `$WORKFLOW_NAME` with your GitHub Actions Workflow name.\n  ```markdown\n  [![Actions Status](https://github.com/$USER/$REPO/workflows/$WORKFLOW_NAME/badge.svg)](https://github.com/$USER/$REPO/actions)\n  ```\n- CircleCI [![CircleCI](https://circleci.com/gh/tom-tan/cwl-for-remote-container-template/tree/master.svg?style=shield)](https://circleci.com/gh/tom-tan/cwl-for-remote-container-template/tree/master)\n  ```markdown\n  [![CircleCI](https://circleci.com/gh/$USER/$REPO.svg?style=shield)](https://circleci.com/gh/$USER/$REPO)\n  ```\n- Gitlab CI [![pipeline status](https://gitlab.com/tom-tan/cwl-for-remote-container-template/badges/master/pipeline.svg)](https://gitlab.com/tom-tan/cwl-for-remote-container-template/commits/master)\n  ```markdown\n  [![pipeline status](https://gitlab.com/$USER/$REPO/badges/master/pipeline.svg)](https://gitlab.com/$USER/$REPO/commits/master)\n  ```\n\n## TODO\n- [ ] A tutorial to write CWL\n  - Maybe use [Zatsu method](https://qiita.com/tm_tn/items/7548fb5f9ea44f384b08)\n\n## License\nThis repository is licensed under the [Unlicense](LICENSE) (a.k.a. Public Domain).\nUnder this license, you can:\n- freely use the contents,\n- freely modify the contents,\n- freely change the license, and\n- freely distribute it to others!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftom-tan%2Fcwl-template-for-vscode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftom-tan%2Fcwl-template-for-vscode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftom-tan%2Fcwl-template-for-vscode/lists"}