Skip to content

Commit b313e34

Browse files
NicorettiNicoretti
committed
Add templates
1 parent dd610a3 commit b313e34

File tree

18 files changed

+662
-0
lines changed

18 files changed

+662
-0
lines changed

‎exasol/toolbox/templates/.github/ISSUE_TEMPLATE/bug.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
name: 🐞 Bug Report
3+
about: File a bug report
4+
title: 🐞 <Insert Title>
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
### Checklist
11+
In order to improve the time, how long a bugfix does take, please make sure you address as much as possible of the following checklist.
12+
13+
- [ ] I have reproduced the issue with at least the latest released version of \<PROJECT-NAME\>.
14+
- [ ] I have added references to issues that sound similar.
15+
16+
**Tip: Adding screenshots, outputs and logs help to improve clarity.**
17+
18+
# Summary
19+
<!---
20+
Describe the bug: A clear and concise description of what the bug is.
21+
-->
22+
23+
## Reproducing the Issue
24+
25+
Reproducibility: <pick one of> sporadic, regularly, always
26+
<!---
27+
Describe how to reproduce the bug, e.g.:
28+
1. Go to '...'
29+
2. Click on '....'
30+
3. Scroll down to '....'
31+
4. See error
32+
-->
33+
### Steps to reproduce the behavior:
34+
1. <step 1>
35+
2. <step 2>
36+
3. ....
37+
38+
## Expected Behaviour
39+
<!---
40+
Describe the expected behaviour: A clear and concise description of what you expected to happen.
41+
-->
42+
43+
## Actual Behaviour
44+
<!---
45+
Describe the actual observed behaviour: A clear and concise description of what you actually to happen.
46+
Screenshot: If applicable, add screenshots to help explain your problem.
47+
-->
48+
49+
## Root Cause (optional)
50+
<!---
51+
If known
52+
-->
53+
54+
55+
## Context
56+
<!---
57+
Describe the actual observed behaviour: A clear and concise description of what you observed.
58+
Screenshot: If applicable, add screenshots to help explain your problem.
59+
-->
60+
61+
### System
62+
<!---
63+
Describe the system and the used configuration.
64+
-->
65+
**Desktop:**
66+
- OS: [e.g. Linux (Fedora 35), Linux (Ubuntu 20.01), MacOs (...), Windows (...)]
67+
- Python Version [e.g. Python 3.8.0]
68+
- Package Version [e.g. 22]
69+
70+
### Additional Context (optional)
71+
<!---
72+
Add any additional context about the problem here.
73+
-->
74+
75+
#### Related Issues (optional)
76+
<!---
77+
Link related issues form the issue tracker here.
78+
-->

‎exasol/toolbox/templates/.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: 📚 Documentation
3+
about: Add/Improve Documentation
4+
title: 📚 <Insert Title>
5+
labels: documentation
6+
assignees: ''
7+
8+
---
9+
10+
# Summary
11+
<!---
12+
A short summary on what of what needs to be documented or updated.
13+
--->
14+
15+
# Details
16+
<!---
17+
A detailed description about what kind of documentation should be added and/or updated and why.
18+
--->
19+
20+
## Background & Context
21+
<!---
22+
Why should this documentation be added/updated?
23+
24+
E.g.: Users are struggling to use this API and have repeatedly asked for some example code.
25+
--->
26+
27+
## References
28+
<!---
29+
Further references to e.g. other information resources like links to specification(s), api docs etc.
30+
--->
31+
32+
# Task(s)
33+
<!---
34+
A task list containing common task associated with this kind of issue, but also tasks specific to this issue.
35+
36+
e.g.:
37+
- [ ] Update documentation of XYZ
38+
- [ ] Bump version number
39+
- [ ] Update changelog
40+
- [ ] ...
41+
--->

‎exasol/toolbox/templates/.github/ISSUE_TEMPLATE/feature.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: ✨ Feature
3+
about: Add/Implement Feature
4+
title: ✨ <Insert Title>
5+
labels: feature
6+
assignees: ''
7+
8+
---
9+
10+
# Summary
11+
<!---
12+
A short description of the feature (TL;DR)
13+
--->
14+
15+
# Details
16+
<!---
17+
A detailed description about what should be added, background, links, context information
18+
and usage example(s) of the feature.
19+
--->
20+
21+
## Background & Context
22+
<!---
23+
What is the motivation for the feature?
24+
Assessment of the feature. Pros & cons, solutions and decisions concerning the feature (reasoning).
25+
--->
26+
27+
## Examples
28+
<!---
29+
Example usage(s) of the feature.
30+
--->
31+
32+
## References
33+
<!---
34+
Further references to e.g. other information resources like links to specification(s) etc.
35+
--->
36+
37+
# Task(s)
38+
<!---
39+
A task list containing common task associated with this kind of issue, but also tasks specific to this issue.
40+
41+
e.g.:
42+
- [ ] Refactor XYZ
43+
- [ ] Bump version number
44+
- [ ] Update documentation
45+
- [ ] Update changelog
46+
- [ ] ...
47+
--->

‎exasol/toolbox/templates/.github/ISSUE_TEMPLATE/refactoring.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: 🔧 Refactoring
3+
about: Refactor
4+
title: 🔧 <Insert Title>
5+
labels: refactoring
6+
assignees: ''
7+
8+
---
9+
10+
# Summary
11+
<!---
12+
A short description of the planed refactoring (TL;DR)
13+
--->
14+
15+
# Details
16+
<!---
17+
A detailed description about what and how it should be refactored, background, links, context information
18+
and example(s) of how "the refactoring should look".
19+
--->
20+
21+
## Background & Context
22+
<!---
23+
What is the motivation for the refactoring?
24+
Assessment of the refactoring. Pros & cons, solutions and decisions concerning (reasoning) the refactoring.
25+
--->
26+
27+
## Examples
28+
<!---
29+
Examples of how "the refactoring should look".
30+
--->
31+
32+
## References
33+
<!---
34+
Further references to e.g. other information resources like links to specification(s) etc.
35+
--->
36+
37+
# Task(s)
38+
<!---
39+
A task list containing common task associated with this kind of issue, but also tasks specific to this issue.
40+
41+
e.g.:
42+
- [ ] Implement XYZ
43+
- [ ] Add tests for XYZ
44+
- [ ] Bump version number
45+
- [ ] Update changelog
46+
- [ ] ...
47+
--->

‎exasol/toolbox/templates/.github/ISSUE_TEMPLATE/security.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: 🔐 Security Issue
3+
about: Fix Security Issue
4+
title: 🔐 <Insert Title>
5+
labels: security
6+
assignees: ''
7+
8+
---
9+
10+
# Summary
11+
<!---
12+
A short summary of the security issue.
13+
--->
14+
15+
| | |
16+
|------------|-----|
17+
| Class/Type | - |
18+
| Version(s) | - |
19+
| Severity | - |
20+
| CVE Number | - |
21+
22+
<!---
23+
A quick table based overview, containing the most important details.
24+
25+
Class/Type: Of vulnerability, e.g. xss, buffer-overflow, ... (see https://cwe.mitre.org/
26+
Versions: Affected software versions
27+
Severity: Of the vulnerability (Low, Medium, High, Critical)
28+
CVE Number: number and link to the cve if available
29+
-->
30+
31+
32+
# Details
33+
34+
### Description
35+
<!---
36+
If no detailed information is available through references or CVE, an extensive
37+
description of the vulnerability should be added here.
38+
--->
39+
40+
### Impact
41+
<!---
42+
Describe the impact of the vulnerability.
43+
--->
44+
45+
### References
46+
<!---
47+
Links to related issues or other sources like link to CVE.
48+
--->
49+
50+
# Solutions
51+
<!--
52+
Describe possible solution(s), how to address this issue.
53+
--->
54+
55+
# Credit
56+
<!--
57+
Whom to thank, kudos for the reporter(s)
58+
-->

‎exasol/toolbox/templates/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
**< PR SPECIFIC CONTENT >**
2+
3+
-------
4+
# ✔ Checklist(s)
5+
6+
* [ ] Is the title of the Pull Request correct?
7+
* [ ] Is the title of the corresponding issue correct?
8+
* [ ] Have you updated the changelog?
9+
* [ ] Have you checked to ensure there aren't other open Pull Requests for the same update/change?
10+
* [ ] Are you mentioning the issue which this PullRequest fixes ("Fixes...")
11+
12+
## 🔐 Security
13+
## 🐞 Bug
14+
## ✨ Feature
15+
## 🔧 Refactoring
16+
## 📚 Documentation

‎exasol/toolbox/templates/.github/actions/python-environment/action.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: 'SPPE'
2+
description: 'Setup python and poetry environment'
3+
4+
inputs:
5+
6+
python-version:
7+
description: 'Python version to use'
8+
required: true
9+
default: 3.8
10+
11+
poetry-version:
12+
description: 'Poetry version to use'
13+
required: true
14+
default: 1.2.2
15+
16+
runs:
17+
18+
using: "composite"
19+
steps:
20+
21+
- name: Setup Python (${{ inputs.python-version}})
22+
uses: actions/setup-python@v4
23+
with:
24+
python-version: ${{ inputs.python-version }}
25+
26+
- name: Setup Poetry (${{ inputs.poetry-version }})
27+
uses: abatilo/actions-poetry@v2
28+
with:
29+
poetry-version: ${{ inputs.poetry-version }}
30+
31+
- name: Poetry install
32+
run: poetry install
33+
shell: bash

‎exasol/toolbox/templates/.github/dependabot.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
version: 2
2+
updates:
3+
4+
# Maintain dependencies for GitHub Actions
5+
- package-ecosystem: "github-actions"
6+
directory: "/"
7+
schedule:
8+
interval: "weekly"
9+
day: "monday"
10+
open-pull-requests-limit: 4
11+
12+
# Maintain dependencies for poetry
13+
- package-ecosystem: "pip"
14+
directory: "/"
15+
schedule:
16+
interval: "weekly"
17+
day: "monday"
18+
open-pull-requests-limit: 4

‎exasol/toolbox/templates/.github/workflows/build-and-publish.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Build & Publish
2+
3+
on:
4+
workflow_call:
5+
secrets:
6+
PYPI_TOKEN:
7+
required: true
8+
9+
jobs:
10+
11+
cd-job:
12+
name: Continues Delivery
13+
runs-on: ubuntu-latest
14+
steps:
15+
16+
- name: SCM Checkout
17+
uses: actions/checkout@v3
18+
19+
- name: Setup Python & Poetry Environment
20+
uses: exasol/python-toolbox/.github/actions/python-environment@main
21+
22+
- name: Build Artifacts
23+
run: poetry build
24+
25+
- name: PyPi Release
26+
env:
27+
POETRY_HTTP_BASIC_PYPI_USERNAME: "__token__"
28+
POETRY_HTTP_BASIC_PYPI_PASSWORD: "${{ secrets.PYPI_TOKEN }}"
29+
run: poetry publish
30+
31+
- name: GitHub Release
32+
env:
33+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
34+
run: >
35+
gh release create ${GITHUB_REF_NAME}
36+
--title ${GITHUB_REF_NAME}
37+
dist/*

0 commit comments

Comments
 (0)