Skip to content

Commit

Permalink
Merge branch 'draft' into issue-413
Browse files Browse the repository at this point in the history
  • Loading branch information
m-mohr authored Jan 3, 2024
2 parents 954c84c + d5d0a18 commit b68d591
Show file tree
Hide file tree
Showing 139 changed files with 3,205 additions and 1,880 deletions.
9 changes: 9 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# EditorConfig is awesome: https://EditorConfig.org

[*.json]
charset = utf-8
end_of_line = crlf
indent_style = spaces
indent_size = 4
insert_final_newline = true
trim_trailing_whitespace = true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Issue or clarification for existing process
about: Report an issue or clarification for an existing process.
title: "[process id]: [issue summary]"
labels: bug, patch
assignees: ''

---

**Process ID:** ...

**Describe the issue:**
A clear and concise description of what needs to be fixed or clarified.

**Proposed solution:**
A potential solution you'd propose.

**Additional context:**
Add any other context about the problem here.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/new-process-parameter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: New process parameter
about: Propose a new process parameter
title: "[process id]: [parameter summary]"
labels: enhancement, minor
assignees: ''

---

**Proposed Process ID:** ... (alphanumeric + underscore only)
**Proposed Parameter Name:** ... (alphanumeric + underscore only)
**Optional:** yes, default: ...

## Context
Give some context and an introduction of what this parameter is needed for, e.g. use cases.

## Description
... (Markdown allowed)

## Data Type
boolean/number/string/array/object/null
... (include additional constraints, e.g. min/max values for numbers or a list of allowed values for strings)

## Additional changes
If required describe any additional changes that are required for the parameter, e.g. an additional data type for the return value, an additional example, an additional link to explain the parameter, etc.
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/new-process-proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
name: New process proposal
about: Propose a new process with detailed specifics (name, description, parameters,
return value etc.). To just pitch an idea without a lot of details, please fill
a "normal" issue.
title: ''
labels: new process
assignees: ''

---

**Proposed Process ID:** ... (alphanumeric + underscore only)

## Context
Give some context and an introduction of what this process is needed for, e.g. use cases.

## Summary
... (max. 60 chars)

## Description
... (min. 55 chars, Markdown allowed)

## Parameters

### `param1` (name of first parameter, alphanumeric + underscore only)

**Optional:** no/yes, default: ... (default value only required for "yes")

#### Description
... (Markdown allowed)

#### Data Type
boolean/number/string/array/object/null
... (include additional constraints, e.g. min/max values for numbers or a list of allowed values for strings)

### `param2` (name of second parameter, copy this template for additional parameters)

**Optional:** no/yes, default: ... (default value only required for "yes")

#### Description
...

#### Data Type
...

## Return Value
### Description
... (Markdown allowed)

### Data Type
boolean/number/string/array/object/null
... (include additional constraints, e.g. min/max values for numbers or a list of allowed values for strings)

## Categories (optional)
* ...
* ...

## Links to additional resources (optional)
* https://...

## Examples (optional)
* ...

## Details about exceptions mentioned in the description (optional)
* ...
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Other issues or proposals
about: Use this if no other option suits your needs and you want to fill a "normal" issue.
title: ''
labels: ''
assignees: ''

---
19 changes: 9 additions & 10 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,33 +9,31 @@ on:
jobs:
deploy:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [14.x]
steps:
- name: Inject env variables
uses: rlespinasse/[email protected]
- uses: actions/setup-node@v1
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
with:
node-version: 'lts/*'
- uses: actions/checkout@v3
- run: |
npm install
npm run generate
working-directory: tests
working-directory: dev
- name: clone gh-pages and clean-up
if: ${{ env.GITHUB_REF_SLUG == 'master' }}
run: |
git clone --branch gh-pages https://github.com/Open-EO/openeo-processes.git gh-pages
find gh-pages -maxdepth 1 -type f -delete
rm -rf gh-pages/examples/
rm -rf gh-pages/meta/
rm -rf gh-pages/proposals/
- name: create empty gh-pages folder
if: ${{ env.GITHUB_REF_SLUG != 'master' }}
run: mkdir gh-pages
- run: |
cp tests/docs.html index.html
cp tests/processes.json processes.json
rsync -vrm --include='*.json' --include='*.html' --include='examples/***' --include='meta/***' --include='proposals/***' --exclude='*' . gh-pages
cp dev/docs.html index.html
cp dev/processes.json processes.json
rsync -vrm --include='*.json' --include='*.html' --include='meta/***' --include='proposals/***' --exclude='*' . gh-pages
- name: deploy to root (master)
uses: peaceiris/actions-gh-pages@v3
if: ${{ env.GITHUB_REF_SLUG == 'master' }}
Expand All @@ -44,6 +42,7 @@ jobs:
publish_dir: gh-pages
user_name: 'openEO CI'
user_email: [email protected]
cname: processes.openeo.org
- name: deploy to ${{ env.GITHUB_REF_SLUG }}
uses: peaceiris/actions-gh-pages@v3
if: ${{ env.GITHUB_REF_SLUG != 'master' }}
Expand Down
15 changes: 7 additions & 8 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,13 @@ on: [push, pull_request]
jobs:
deploy:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [14.x]
steps:
- uses: actions/setup-node@v1
- uses: actions/checkout@v2
- name: Run tests
- uses: actions/setup-node@v3
with:
node-version: 'lts/*'
- uses: actions/checkout@v3
- name: Run linter
run: |
npm install
npm run test
working-directory: tests
npm test
working-directory: dev
Loading

0 comments on commit b68d591

Please sign in to comment.