From a5fb76ea7f79678916bd104272b5a13fbb610e45 Mon Sep 17 00:00:00 2001 From: Venkat Malladi <vmalladi@microsoft.com> Date: Fri, 18 Oct 2024 16:15:57 -0500 Subject: [PATCH 1/2] Fix some of the description in readme and tags. (#1) * Fix some of the description in readme and tags. * Fix build to run based on requirements of plugins --- .github/workflows/build.yml | 27 ++++++++++++++++++++++++--- README.md | 30 ++++++++++++++++++++++++++---- 2 files changed, 50 insertions(+), 7 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 729bd73..eb5c273 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -7,9 +7,9 @@ jobs: runs-on: ubuntu-latest steps: - name: Setup Node.js environment - uses: actions/setup-node@v4.0.4 + uses: actions/setup-node@v4 with: - node-version: 18 + node-version: 14.x # Comes with npm 6. For newer Node, encountered: https://github.com/npm/cli/issues/3359 - run: npm install -g @redocly/openapi-cli && npm install -g redoc-cli - run: npm install -g gh-openapi-docs @@ -17,7 +17,28 @@ jobs: uses: actions/checkout@v4 - run: gh-openapi-docs - name: Deploy 🚀 - uses: JamesIves/github-pages-deploy-action@v4.2.2 + uses: JamesIves/github-pages-deploy-action@v4 with: branch: gh-pages folder: . + deploy: + if: github.ref == 'refs/heads/master' # Only run this job on the master branch + runs-on: ubuntu-latest + steps: + - name: Setup Node.js environment + uses: actions/setup-node@v4 + with: + node-version: 14.x + # Comes with npm 6. For newer Node, encountered: https://github.com/npm/cli/issues/3359 + - run: npm install -g @redocly/openapi-cli && npm install -g redoc-cli + - run: npm install -g gh-openapi-docs + - name: Check out repository code + uses: actions/checkout@v4 + - run: gh-openapi-docs + - name: Deploy 🚀 + uses: JamesIves/github-pages-deploy-action@v4 + with: + branch: gh-pages + folder: . # Folder containing the built documentation + target-folder: docs/index.html # Deploy to docs/index.html if needed + clean: true diff --git a/README.md b/README.md index fa309d0..8f6cde2 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,29 @@ <img src="https://www.ga4gh.org/wp-content/themes/ga4gh/dist/assets/svg/logos/logo-full-color.svg" alt="GA4GH Logo" style="width: 400px;"/> + + + Task Execution Service (TES) API ====================================== -<sup>`master` branch status: </sup>[](https://travis-ci.org/ga4gh/task-execution-schemas?branch=master) -<a href="https://raw.githubusercontent.com/ga4gh/task-execution-schemas/master/openapi/task_execution_service.openapi.yaml"><img src="http://online.swagger.io/validator?url=https://raw.githubusercontent.com/ga4gh/task-execution-schemas/master/openapi/task_execution_service.openapi.yaml" alt="Open API Validator" height="20em" width="72em"></A> + +This repository is the home for the schema for the GA4GH Task Execution API. The Goal of the API is to provide a standardized way to executing batch execution tasks. The [Global Alliance for Genomics and Health](http://genomicsandhealth.org/) is an international coalition, formed to enable the sharing of genomic and clinical data. Cloud Work Stream ----------------- +The [Cloud Work Stream](https://ga4gh.cloud) helps the genomics and health communities take full advantage of modern +cloud environments. +Our initial focus is on “bringing the algorithms to the data”, by creating standards for defining, sharing, and +executing portable workflows. + +We work with platform development partners and industry leaders to develop standards that will facilitate +interoperability. + +Cloud Work Stream +----------------- + The [Cloud Work Stream](https://ga4gh.cloud) helps the genomics and health communities take full advantage of modern cloud environments. Our initial focus is on “bringing the algorithms to the data”, by creating standards for defining, sharing, and executing portable workflows. @@ -27,9 +41,17 @@ API Definition -------------- See the human-readable [Reference Documentation](https://ga4gh.github.io/task-execution-schemas/docs/) -and the [OpenAPI YAML description](openapi/task_execution_service.openapi.yaml). You can also explore the specification in the [Swagger Editor](https://editor.swagger.io/?url=https://ga4gh.github.io/task-execution-schemas/openapi.yaml). +You can also explore the specification in +the [Swagger Editor](https://editor.swagger.io/?url=https://ga4gh.github.io/task-execution-schemas/openapi.yaml)** +*Manually load the JSON if working from a non-develop branch version.* Preview documentation from +the [gh-openapi-docs](https://github.com/ga4gh/gh-openapi-docs) for the development +branch [here](https://ga4gh.github.io/task-execution-schemas/preview/develop/docs/index.html) + +> All documentation and pages hosted at 'ga4gh.github.io/task-execution-schemas' reflect the latest API release from +> the `master` branch. To monitor the latest development work, add 'preview/\<branch\>' to the URLs above (e.g., ' +> ga4gh.github.io/task-execution-schemas/preview/\<branch\>/docs'). To view the latest *stable* +> development API specification, refer to the `develop` branch. -> All documentation and pages hosted at 'ga4gh.github.io/task-execution-schemas' reflect the latest API release from the `master` branch. To monitor the latest development work, add 'preview/\<branch\>' to the URLs above (e.g., 'ga4gh.github.io/task-execution-schemas/preview/\<branch\>/docs'). TES Compliant Implementations ------------------------------ From b0c08ee2e65327c36deee6bbe99f3e446ee2a728 Mon Sep 17 00:00:00 2001 From: Venkat Malladi <vmalladi@microsoft.com> Date: Sun, 20 Oct 2024 13:48:30 -0500 Subject: [PATCH 2/2] Resolve issue with two sections --- README.md | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/README.md b/README.md index 8f6cde2..ff75c5a 100644 --- a/README.md +++ b/README.md @@ -13,17 +13,6 @@ The [Global Alliance for Genomics and Health](http://genomicsandhealth.org/) is Cloud Work Stream ----------------- -The [Cloud Work Stream](https://ga4gh.cloud) helps the genomics and health communities take full advantage of modern -cloud environments. -Our initial focus is on “bringing the algorithms to the data”, by creating standards for defining, sharing, and -executing portable workflows. - -We work with platform development partners and industry leaders to develop standards that will facilitate -interoperability. - -Cloud Work Stream ------------------ - The [Cloud Work Stream](https://ga4gh.cloud) helps the genomics and health communities take full advantage of modern cloud environments. Our initial focus is on “bringing the algorithms to the data”, by creating standards for defining, sharing, and executing portable workflows.