Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fi build and readme #220

Merged
merged 2 commits into from
Oct 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 24 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,38 @@ 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
- name: Check out repository code
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
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
<img src="https://www.ga4gh.org/wp-content/themes/ga4gh/dist/assets/svg/logos/logo-full-color.svg" alt="GA4GH Logo" style="width: 400px;"/>

![release_badge](https://img.shields.io/github/v/tag/ga4gh/task-execution-schemas)


Task Execution Service (TES) API
======================================
<sup>`master` branch status: </sup>[![Build Status](https://travis-ci.org/ga4gh/task-execution-schemas.svg?branch=master)](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.

Expand All @@ -27,9 +30,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
------------------------------
Expand Down
Loading