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

fractional resource requirements for CWL 1.1 and 1.2 spec #230

Open
wants to merge 74 commits into
base: develop-v1.2
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
74 commits
Select commit Hold shift + click to select a range
4a56260
Update README.md
alextsaihi Feb 5, 2024
0c95751
Fix build docs.
vsmalladi Sep 30, 2024
ebde4bb
Update build.yml
vsmalladi Oct 4, 2024
1de8ebe
Update ci.yml
vsmalladi Oct 4, 2024
d49bc65
Merge pull request #218 from vsmalladi/197-branch
vsmalladi Oct 8, 2024
2082a8f
Merge pull request #201 from alextsaihi/ga4gh-logo-update
vsmalladi Oct 18, 2024
a5fb76e
Fix some of the description in readme and tags. (#1)
vsmalladi Oct 18, 2024
b0c08ee
Resolve issue with two sections
vsmalladi Oct 20, 2024
4362315
Merge pull request #220 from vsmalladi/develop
vsmalladi Oct 20, 2024
b0eb2d5
Update logo
vsmalladi Oct 21, 2024
c157712
Merge pull request #221 from vsmalladi/develop
vsmalladi Oct 21, 2024
42bb695
Update to be linked to the latest tag.
vsmalladi Oct 24, 2024
a0da756
Fix repo.
vsmalladi Oct 24, 2024
93b1e3a
Add back build and spec badges.
vsmalladi Oct 24, 2024
0c05b27
Check with develop.
vsmalladi Oct 24, 2024
d04eca1
Testing ci badge.
vsmalladi Oct 24, 2024
6288dc4
Testing ci badge.
vsmalladi Oct 24, 2024
c4f8d98
check validtor.
vsmalladi Oct 24, 2024
244a8b8
Make a table and visualize all on the status for both master and deve…
vsmalladi Oct 24, 2024
4bf02c6
Change the develop branch name.
vsmalladi Oct 24, 2024
f6495ef
Reword description.
vsmalladi Oct 24, 2024
d9ebe9c
Fix formating and full stops.
vsmalladi Oct 24, 2024
c02bcb9
Add rewording.
vsmalladi Oct 24, 2024
a248cde
Update JSON.
vsmalladi Oct 24, 2024
b287476
Remove Possible future enhancemnts section.
vsmalladi Oct 24, 2024
7f253a0
Add Governance.
vsmalladi Oct 24, 2024
9b19cf7
Add in license.
vsmalladi Oct 24, 2024
8614de7
Fix badges.
vsmalladi Oct 24, 2024
07cbe93
Simplify build.
vsmalladi Oct 28, 2024
aab9eba
Build in PR.
vsmalladi Oct 28, 2024
a55038c
Change the plugin to be used so doesnt require secrets.
vsmalladi Oct 28, 2024
ab2f679
Fix security.
vsmalladi Oct 28, 2024
7e0f90c
Fix spelling error.
vsmalladi Oct 28, 2024
15c3088
update for security.
vsmalladi Oct 28, 2024
31dbd36
Update links.
vsmalladi Oct 28, 2024
6834190
Fix some wording.
vsmalladi Oct 28, 2024
3d1733b
Fix build.
vsmalladi Oct 28, 2024
6209a56
Fix build.
vsmalladi Oct 28, 2024
fc905dd
Fix build.
vsmalladi Oct 28, 2024
e482eac
Fix build syntax.
vsmalladi Oct 28, 2024
04550ed
Add in push.
vsmalladi Oct 28, 2024
4592b2a
Fix voting.
vsmalladi Oct 28, 2024
639ca06
Merge pull request #222 from vsmalladi/develop
vsmalladi Oct 28, 2024
2bafe3d
Update GOVERNANCE.md
uniqueg Oct 29, 2024
f43298b
Update build.yml
uniqueg Oct 29, 2024
e10cdb0
Update build.yml
uniqueg Oct 29, 2024
9a3e78d
Update build.yml
uniqueg Oct 29, 2024
00946b3
Update README.md
uniqueg Oct 29, 2024
060d08a
Update README.md
uniqueg Oct 29, 2024
9a38e48
Update README.md
uniqueg Oct 29, 2024
e6a5275
Update README.md
uniqueg Oct 29, 2024
5fdc081
Update README.md
uniqueg Oct 29, 2024
e87ac17
Update README.md
uniqueg Oct 29, 2024
cf7b478
Update CONTRIBUTING.md
uniqueg Oct 29, 2024
22d7ae7
Update CONTRIBUTING.md
uniqueg Oct 29, 2024
df497df
Merge pull request #223 from ga4gh/uniqueg-patch-1
vsmalladi Oct 29, 2024
6f40e15
Merge pull request #224 from ga4gh/uniqueg-patch-2
vsmalladi Oct 29, 2024
e15a1aa
Merge pull request #225 from ga4gh/uniqueg-patch-3
vsmalladi Oct 29, 2024
3ba6a09
Merge pull request #226 from ga4gh/uniqueg-patch-4
vsmalladi Oct 29, 2024
8fed9ee
Create diff_comment.yml
uniqueg Oct 29, 2024
556b134
Update diff_comment.yml
uniqueg Oct 29, 2024
ed4499b
Update diff_comment.yml
uniqueg Oct 29, 2024
2f6a18a
Update diff_comment.yml
uniqueg Oct 29, 2024
2ea05ea
Update diff_comment.yml
uniqueg Oct 29, 2024
7cb1d0c
Update diff_comment.yml
uniqueg Oct 29, 2024
8379c63
Update diff_comment.yml
uniqueg Oct 29, 2024
98143d2
Update diff_comment.yml
uniqueg Oct 29, 2024
dc099c8
Update diff_comment.yml
uniqueg Oct 29, 2024
d41e922
Update diff_comment.yml
uniqueg Oct 30, 2024
13e7b96
Update diff_comment.yml
uniqueg Oct 30, 2024
f099807
Delete .github/workflows/diff_comment.yml
uniqueg Oct 30, 2024
1f58489
Add in fractional values for cwl
vsmalladi Nov 8, 2024
715e5e8
Update openapi/task_execution_service.openapi.yaml
vsmalladi Nov 15, 2024
eddedc5
Update openapi/task_execution_service.openapi.yaml
vsmalladi Nov 15, 2024
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
24 changes: 14 additions & 10 deletions .github/workflows/build-docs.yml → .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,26 +1,30 @@
name: Build OpenAPI docs
on:
- push
# - pull_request
on:
push:
branches:
- main
- develop
- 'release*'
pull_request:
types: [opened, reopened, sychronize]
jobs:
docs-build:
runs-on: ubuntu-latest
# env:
# TRAVIS_BRANCH: ${{ github.event.number }}
# a trick that builds docs for PRs (with PR number). Does not work for PRs from forks.
steps:
- name: Setup Node.js environment
uses: actions/setup-node@v2.5.1
with:
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@v2
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: .
target-folder: ${{ github.ref == 'refs/heads/main' && 'docs/index.html' || '' }} # Deploy to docs/index.html only if on main
clean: ${{ github.ref == 'refs/heads/main' }} # Clean only if on the main branch
Original file line number Diff line number Diff line change
@@ -1,37 +1,31 @@
name: Lint and validate OpenAPI specs

on:
- push
- pull_request

jobs:

lint:
name: Lint OpenAPI definition
runs-on: ubuntu-latest
steps:
- name: Check out head branch
uses: actions/checkout@v2
uses: actions/checkout@v4
- name: Run OpenAPI Lint Action
uses: nwestfall/openapi-action@v1.0.2
uses: mhiew/redoc-lint-github-action@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
file: openapi/task_execution_service.openapi.yaml

args: 'openapi/task_execution_service.openapi.yaml'
diff:
name: Show OpenAPI differences relative to target branch
runs-on: ubuntu-latest
if: ${{ github.event_name == 'pull_request' }}
steps:
- name: Check out head branch
uses: actions/checkout@v2
uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
ref: ${{ github.ref }}
path: head
- name: Check out base branch
uses: actions/checkout@v2
uses: actions/checkout@v4
with:
ref: ${{ github.base_ref }}
ref: ${{ github.event.pull_request.base.ref }}
path: base
- name: Run OpenAPI Diff Action
uses: mvegter/openapi-diff-action@v0.23.5
Expand All @@ -44,7 +38,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out head branch
uses: actions/checkout@v2
uses: actions/checkout@v4
- name: Run OpenAPI Validate Action
uses: char0n/swagger-editor-validate@v1
with:
Expand Down
63 changes: 38 additions & 25 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,47 @@

# CONTRIBUTING

This schema is developed by the [Cloud Work Stream](https://ga4gh.cloud) of the [Global Alliance for Genomics and Health](https://ga4gh.org).
This schema is developed by the [Cloud Work
Stream]([https://ga4gh.cloud](https://www.ga4gh.org/work_stream/cloud/)) of the
[Global Alliance for Genomics and Health](https://ga4gh.org).

## Semantic Versioning

We use [semantic versioning](https://semver.org/) for TES, this will determine if your proposed changes impact a major or minor release.
The Task Execution Service (TES) API uses [semantic
versioning](https://semver.org/) for TES. Please consider that breaking changes
imply a new major version release, which is associated with considerable
administrative work and therefore happen only rarely.

## Suggesting Changes

Suggested changes to this schema can be initiated as [**Issues**](https://github.com/ga4gh/task-execution-schemas/issues) or [**Pull Requests**](https://github.com/ga4gh/task-execution-schemas/pulls) to allow for discussion and review.

Even those with write access to the main repository should in general create pull request branches within their own forks. This way when the main repository is forked again, the new fork is created with a minimum of extraneous volatile branches.

> To facilitate review of external pull requests, users are encouraged to activate [**Travis CI**](https://travis-ci.org/) to monitor the build status (documentation, Swagger UI) of their fork. By following the documentation for [deployment to GitHub Pages](https://docs.travis-ci.com/user/deployment/pages/) and adding a `$GITHUB_TOKEN` environment variable to their repo configuration, pushes to the forked repo should be viewable relative to `https://[user-or-org].github.io/workflow-execution-service-schemas/preview/<branch>/`:

+ https://[user-or-org].github.io/task-execution-schemas/preview/\<branch\>/docs/
+ https://[user-or-org].github.io/task-execution-schemas/preview/\<branch\>/swagger-ui/
+ https://[user-or-org].github.io/task-execution-schemas/preview/\<branch\>/swagger.json
+ https://[user-or-org].github.io/task-execution-schemas/preview/\<branch\>/swagger.yaml

> Providing this base URL in the pull request comment is appreciated, but not required.

If a security vulnerability is identified with the specification please send an email to security-notification@ga4gh.org detailing your concerns.

## Approving Changes

### pre-TES v1.0.0 / Testbed Voting Procedure
Changes for the release are to be approved by 2 TES specification leads.

### post TES v1.0.0 Voting Procedure
The post v1.0.0 voting group include stakeholders, such as server and client implementors.
The membership of this group will be established as part of the v1.0.0 release.
Changes to TES can be initiated as
[**issues**](https://github.com/ga4gh/task-execution-schemas/issues) or
[**pull requests**](https://github.com/ga4gh/task-execution-schemas/pulls) to
allow for discussion and review. For considerable changes, we generally
recommend opening issues first in order to discuss scope and feasibility.

When creating pull requests, please do so from your own fork - even if you have
write access to the repository. In this way, when the main repository is forked
again, the new fork is created with a minimum of extraneous, volatile branches.

> To facilitate the review of external pull requests, users are encouraged to
> activate [**GitHub Actions**](https://github.com/features/actions) to monitor
> the build status of their fork. By following the documentation for [deployment
> to GitHub
> Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site),
> pushes to the forked repository will be viewable at
> `https://[user-or-org].github.io/task-execution-service/preview/<branch>/`,
> e.g.,:
> - `https://[user-or-org].github.io/task-execution-schemas/preview/\<branch\>/docs/`
> - `https://[user-or-org].github.io/task-execution-schemas/preview/\<branch\>/swagger-ui/`
> - `https://[user-or-org].github.io/task-execution-schemas/preview/\<branch\>/swagger.json`
> - `https://[user-or-org].github.io/task-execution-schemas/preview/\<branch\>/swagger.yaml`

Providing this base URL in the pull request comment is appreciated, but not
required.

If a security vulnerability is identified with the specification, please send an
email to <mailto:security-notification@ga4gh.org> detailing your concerns.

For more information please refer to the [**governance
documentation**](GOVERNANCE.md).
19 changes: 19 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
TES Governance and Process
==============================

The Task Execution Service (TES) operates under a community-driven development model, where advancements to the specification occur exclusively through community contributions. The standard is governed by a core team of Product Leads that fosters collaboration and consensus among contributors. This team is tasked with overseeing the design and development processes, setting priorities, managing the release schedule, and making decisions in instances where consensus cannot be reached.

Current TES Product Leads are:

| Name | Organization | github |
|:-------------------|:-------------|:------------------
| Kyle Ellrot | [Oregon Health and Science University](https://www.ohsu.edu/) | [kellrott](https://github.com/kellrott) |
| Venkat Malladi | [Microsoft](https://www.microsoft.com/en-us/genomics/) | [vsmalladi](https://github.com/vsmalladi) |
| Alex Kanitz | [Swiss Institute of Bioinformatics / ELIXIR Switzerland](https://www.sib.swiss/) | [uniqueg](https://github.com/uniqueg) |


## Voting Procedure

Proposed changes and releases are voted on by Driver Project champions and other key stakeholders, such as product implementers (client- and sever-side). Product Leads review proposed changes on a regular product-specific call, then solicit community feedback during regular Cloud Work Stream calls and through the [product-specific](mailto:ga4gh-cloud-tes+subscribe@ga4gh.org) mailing list for a specified time period. Proposed releases are further shared through official GA4GH channels (Slack board and mailing list with wider scope) and with a longer feedback period. Product Leads, in close connection with the Cloud Work Stream leadership, will always strive to reach broad consensus, but may accept simple majority decisions if broad consensus cannot be reached.

Sign up for the [**GA4GH TES API mailing list**](mailto:ga4gh-cloud-tes+subscribe@ga4gh.org) to stay updated about the latest news and developments around the TES API, in particular for soliciting comments on proposed specification changes and for notifications about TES subgroup meetings.
Loading