Skip to content

Commit b929d26

Browse files
pcrespovpcrespov
authored
📝 Maintenance/GitHub issue templates (ITISFoundation#2673)
1 parent f800eba commit b929d26

File tree

6 files changed

+128
-43
lines changed

6 files changed

+128
-43
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
name: 🐛 Bug
3+
about: File a bug/issue
4+
labels: bug
5+
6+
---
7+
18
## Long story short
29

310
<!-- Please describe your problem and why the fix is important. -->

‎.github/ISSUE_TEMPLATE/e2e_report.md‎

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,45 @@
11
---
22
name: e2e failure report
3-
about: Report an issue in e2e (only for testers)
3+
about: Report an issue found during e2e (only for testers)
44
labels: e2e
55

66
---
77

8-
## what fails:
8+
9+
<!-- Autogenerated by echo_github_issue_template_e2e_report.py at 2021-12-01T15:45:38.824014 -->
10+
11+
## what fails?
912
- [ ] [isolve-gpu]
1013
- [ ] [isolve-mpi]
1114
- [ ] [jupyters]
1215
- [ ] [mattward]
16+
- [ ] [parallel_w_jupyters]
1317
- [ ] [sim4life]
1418
- [ ] [sleepers]
15-
- [ ] [parallel_w_jupyters]
1619

1720
## where
18-
- [ ] e2e-master
19-
- [ ] e2e-dalco-staging
20-
- [ ] e2e-dalco-production
21-
- [ ] e2e-aws-staging
22-
- [ ] e2e-aws-production
23-
24-
## how
25-
26-
<!--describe details here -->
27-
28-
29-
21+
- [ ] [e2e/master]
22+
- [ ] [e2e/dalco/staging]
23+
- [ ] [e2e/dalco/production]
24+
- [ ] [e2e/aws/staging]
25+
- [ ] [e2e/aws/production]
26+
27+
28+
## known temporary fix
3029

3130

3231
<!--Keep references at the bottom -->
33-
[isolve-gpu]:(https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/isolve-gpu.js)
34-
[isolve-mpi]:(https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/isolve-mpi.js)
35-
[jupyters]:(https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/jupyters.js)
36-
[mattward]:(https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/mattward.js)
37-
[sim4life]:(https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/sim4life.js)
38-
[sleepers]:(https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/sleepers.js)
39-
[parallel_w_jupyters]:(https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/jupyters.js)
32+
[mattward]:https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/mattward.js
33+
[isolve-mpi]:https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/isolve-mpi.js
34+
[isolve-gpu]:https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/isolve-gpu.js
35+
[sim4life]:https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/sim4life.js
36+
[jupyters]:https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/jupyters.js
37+
[sleepers]:https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/sleepers.js
38+
[parallel_w_jupyters]:https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/jupyters.js
39+
40+
41+
[e2e/master]:https://git.speag.com/oSparc/e2e-testing/-/pipelines?page=1&scope=all&ref=master
42+
[e2e/dalco/staging]:https://git.speag.com/oSparc/e2e-testing/-/pipelines?page=1&scope=all&ref=staging
43+
[e2e/dalco/production]:https://git.speag.com/oSparc/e2e-testing/-/pipelines?page=1&scope=all&ref=production
44+
[e2e/aws/staging]:https://git.speag.com/oSparc/e2e-testing/-/pipelines?page=1&scope=all&ref=staging_aws
45+
[e2e/aws/production]:https://git.speag.com/oSparc/e2e-testing/-/pipelines?page=1&scope=all&ref=production_aws

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: Feature request
2+
name: ✨ Feature request
33
about: Suggest an idea to implement in the simcore plaform
44

55
---

‎.github/ISSUE_TEMPLATE/tester_report.md‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.github/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Tips on .github configuration
2+
3+
4+
5+
## [Issues and pull request templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)
6+
7+
- ``PULL_REQUEST_TEMPLATE.md``
8+
- ``ISSUE_TEMPLATE`` folder:
9+
- Add [top-level syntax](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax) to ISSUE_TEMPLATE/*.md files to configure them and view them as [template in the github web](https://github.com/ITISFoundation/osparc-simcore/issues/new/choose)

‎scripts/echo_github_issue_template_e2e_report.py‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
import sys
2+
from datetime import datetime
3+
from pathlib import Path
4+
5+
CURRENT_FILE = Path(sys.argv[0] if __name__ == "__main__" else __name__)
6+
CURRENT_DIR = CURRENT_FILE.resolve().parent
7+
REPO_DIR = CURRENT_DIR.parent
8+
9+
ITEM_BULLET = " - [ ]"
10+
CI_BASEURL_FORMAT = "https://git.speag.com/oSparc/e2e-testing/-/pipelines?page=1&scope=all&ref={branch_name}"
11+
TARGET_DIR = REPO_DIR / "tests" / "e2e" / "tutorials"
12+
13+
DEPLOY_LOCATIONS = ("master", "dalco", "aws")
14+
DEPLOY_FLAVOURS = ("staging", "production")
15+
16+
17+
def main():
18+
"""
19+
Prints e2e_report.md using a template and the scripts available under tests/e2e
20+
21+
Usage:
22+
23+
cd osparc-simcore/scripts
24+
python echo_github_issue_template_e2e_report.py >> ../.github/ISSUE_TEMPLATE/e2e_report.md
25+
26+
"""
27+
# list e2e scripts
28+
scripts = [
29+
script_path
30+
for script_path in TARGET_DIR.glob("*.js")
31+
if not script_path.name.endswith("Base.js")
32+
]
33+
34+
# create ref links
35+
refs = {
36+
f"[{p.stem}]": f"https://github.com/ITISFoundation/osparc-simcore/blob/master/{p.relative_to(REPO_DIR)}"
37+
for p in scripts
38+
}
39+
refs.update({"[parallel_w_jupyters]": refs["[jupyters]"]})
40+
41+
# Template for e2e_report.md --------
42+
print(
43+
f"<!-- Autogenerated by {CURRENT_FILE} at {datetime.now().isoformat()} --> ",
44+
end="\n" * 2,
45+
)
46+
47+
print("## what fails?")
48+
for r in sorted(refs.keys()):
49+
print(ITEM_BULLET, r)
50+
51+
print()
52+
print("## where")
53+
for p in DEPLOY_LOCATIONS:
54+
if p != "master":
55+
for q in DEPLOY_FLAVOURS:
56+
print(ITEM_BULLET, f"[e2e/{p}/{q}]")
57+
else:
58+
print(ITEM_BULLET, f"[e2e/{p}]")
59+
60+
print(end="\n" * 2)
61+
62+
print("<!--Keep references at the bottom -->")
63+
#
64+
for r, v in refs.items():
65+
print(f"{r}:{v}")
66+
67+
print(end="\n" * 2)
68+
69+
# deploys
70+
for p in DEPLOY_LOCATIONS:
71+
if p != "master":
72+
for q in DEPLOY_FLAVOURS:
73+
brh = q
74+
if p == "aws":
75+
brh += "_aws"
76+
print(f"[e2e/{p}/{q}]:{CI_BASEURL_FORMAT.format(branch_name=brh)}")
77+
else:
78+
print(f"[e2e/{p}]:{CI_BASEURL_FORMAT.format(branch_name=p)}")
79+
80+
81+
if __name__ == "__main__":
82+
83+
main()

0 commit comments

Comments
 (0)