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

Updates to Readme #222

Merged
merged 31 commits into from
Oct 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
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
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
28 changes: 5 additions & 23 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
name: Build OpenAPI docs
on:
- push
# - pull_request
push:
pull_request:
types: [opened, reopened, sychronize]
jobs:
docs-build:
runs-on: ubuntu-latest
Expand All @@ -21,24 +22,5 @@ jobs:
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
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
10 changes: 4 additions & 6 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
name: Lint and validate OpenAPI specs
on:
- push
- pull_request_target
- pull_request
jobs:
lint:
name: Lint OpenAPI definition
Expand All @@ -10,17 +9,16 @@ jobs:
- name: Check out head branch
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: aactions/checkout@v4
uses: actions/checkout@v4
with:
ref: ${{ github.ref }}
path: head
Expand Down
13 changes: 4 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ Suggested changes to this schema can be initiated as [**Issues**](https://github

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>/`:

> 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 (documentation, Swagger UI) 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>/`:


+ https://[user-or-org].github.io/task-execution-schemas/preview/\<branch\>/docs/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are the Swagger links still up to date, actually?

+ https://[user-or-org].github.io/task-execution-schemas/preview/\<branch\>/swagger-ui/
Expand All @@ -24,11 +26,4 @@ Even those with write access to the main repository should in general create pul

If a security vulnerability is identified with the specification please send an email to [email protected] 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.
For more information please see the [Governance](GOVERNANCE.md) documentation.
23 changes: 23 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
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 governance is steered by a core team of API champions 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 API 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

Voting group include stakeholders, such as server and client implementors.

API Product leads review PR's on a reguarly cal (and also ping the mailing list), set a deadline by which drivers (and a few key non-drivers) need to respond by. Strive to reach consensus with our drivers and community.

Cloud Work Stream leads retain a veto if something goes off the rails.

[GA4GH TES API mailing list](mailto:[email protected]): to stay updated about the latest news & developments around the TES API, in particular for soliciting comments on proposed spec changes and for notifications about TES subgroup meetings.
Loading
Loading