📝 Maintenance/GitHub issue templates

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,3 +1,10 @@
+---
+name: 🐛 Bug
+about: File a bug/issue
+labels: bug
+
+---
+
 ## Long story short
 
 <!-- Please describe your problem and why the fix is important. -->

.github/ISSUE_TEMPLATE/e2e_report.md

@@ -1,39 +1,45 @@
 ---
 name: e2e failure report
-about: Report an issue in e2e (only for testers)
+about: Report an issue found during e2e (only for testers)
 labels: e2e
 
 ---
 
-## what fails:
+
+<!-- Autogenerated by echo_github_issue_template_e2e_report.py at 2021-12-01T15:45:38.824014 -->
+
+## what fails?
   - [ ] [isolve-gpu]
   - [ ] [isolve-mpi]
   - [ ] [jupyters]
   - [ ] [mattward]
+  - [ ] [parallel_w_jupyters]
   - [ ] [sim4life]
   - [ ] [sleepers]
-  - [ ] [parallel_w_jupyters]
 
 ## where
-  - [ ] e2e-master
-  - [ ] e2e-dalco-staging
-  - [ ] e2e-dalco-production
-  - [ ] e2e-aws-staging
-  - [ ] e2e-aws-production
-
-## how
-
-<!--describe details here -->
-
-
-
+  - [ ] [e2e/master]
+  - [ ] [e2e/dalco/staging]
+  - [ ] [e2e/dalco/production]
+  - [ ] [e2e/aws/staging]
+  - [ ] [e2e/aws/production]
+
+
+ ## known temporary fix
 
 
 <!--Keep references at the bottom -->
-[isolve-gpu]:(https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/isolve-gpu.js)
-[isolve-mpi]:(https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/isolve-mpi.js)
-[jupyters]:(https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/jupyters.js)
-[mattward]:(https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/mattward.js)
-[sim4life]:(https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/sim4life.js)
-[sleepers]:(https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/sleepers.js)
-[parallel_w_jupyters]:(https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/jupyters.js)
+[mattward]:https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/mattward.js
+[isolve-mpi]:https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/isolve-mpi.js
+[isolve-gpu]:https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/isolve-gpu.js
+[sim4life]:https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/sim4life.js
+[jupyters]:https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/jupyters.js
+[sleepers]:https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/sleepers.js
+[parallel_w_jupyters]:https://github.com/ITISFoundation/osparc-simcore/blob/master/tests/e2e/tutorials/jupyters.js
+
+
+[e2e/master]:https://git.speag.com/oSparc/e2e-testing/-/pipelines?page=1&scope=all&ref=master
+[e2e/dalco/staging]:https://git.speag.com/oSparc/e2e-testing/-/pipelines?page=1&scope=all&ref=staging
+[e2e/dalco/production]:https://git.speag.com/oSparc/e2e-testing/-/pipelines?page=1&scope=all&ref=production
+[e2e/aws/staging]:https://git.speag.com/oSparc/e2e-testing/-/pipelines?page=1&scope=all&ref=staging_aws
+[e2e/aws/production]:https://git.speag.com/oSparc/e2e-testing/-/pipelines?page=1&scope=all&ref=production_aws

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,5 +1,5 @@
 ---
-name: Feature request
+name: ✨  Feature request
 about: Suggest an idea to implement in the simcore plaform
 
 ---

.github/README.md

@@ -0,0 +1,9 @@
+# Tips on .github configuration
+
+
+
+## [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)
+
+- ``PULL_REQUEST_TEMPLATE.md``
+- ``ISSUE_TEMPLATE`` folder:
+  - 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

@@ -0,0 +1,83 @@
+import sys
+from datetime import datetime
+from pathlib import Path
+
+CURRENT_FILE = Path(sys.argv[0] if __name__ == "__main__" else __name__)
+CURRENT_DIR = CURRENT_FILE.resolve().parent
+REPO_DIR = CURRENT_DIR.parent
+
+ITEM_BULLET = "  - [ ]"
+CI_BASEURL_FORMAT = "https://git.speag.com/oSparc/e2e-testing/-/pipelines?page=1&scope=all&ref={branch_name}"
+TARGET_DIR = REPO_DIR / "tests" / "e2e" / "tutorials"
+
+DEPLOY_LOCATIONS = ("master", "dalco", "aws")
+DEPLOY_FLAVOURS = ("staging", "production")
+
+
+def main():
+    """
+    Prints e2e_report.md using a template and the scripts available under tests/e2e
+
+    Usage:
+
+        cd osparc-simcore/scripts
+        python echo_github_issue_template_e2e_report.py >> ../.github/ISSUE_TEMPLATE/e2e_report.md
+
+    """
+    # list e2e scripts
+    scripts = [
+        script_path
+        for script_path in TARGET_DIR.glob("*.js")
+        if not script_path.name.endswith("Base.js")
+    ]
+
+    # create ref links
+    refs = {
+        f"[{p.stem}]": f"https://github.com/ITISFoundation/osparc-simcore/blob/master/{p.relative_to(REPO_DIR)}"
+        for p in scripts
+    }
+    refs.update({"[parallel_w_jupyters]": refs["[jupyters]"]})
+
+    # Template for e2e_report.md --------
+    print(
+        f"<!-- Autogenerated by {CURRENT_FILE} at {datetime.now().isoformat()} --> ",
+        end="\n" * 2,
+    )
+
+    print("## what fails?")
+    for r in sorted(refs.keys()):
+        print(ITEM_BULLET, r)
+
+    print()
+    print("## where")
+    for p in DEPLOY_LOCATIONS:
+        if p != "master":
+            for q in DEPLOY_FLAVOURS:
+                print(ITEM_BULLET, f"[e2e/{p}/{q}]")
+        else:
+            print(ITEM_BULLET, f"[e2e/{p}]")
+
+    print(end="\n" * 2)
+
+    print("<!--Keep references at the bottom -->")
+    #
+    for r, v in refs.items():
+        print(f"{r}:{v}")
+
+    print(end="\n" * 2)
+
+    # deploys
+    for p in DEPLOY_LOCATIONS:
+        if p != "master":
+            for q in DEPLOY_FLAVOURS:
+                brh = q
+                if p == "aws":
+                    brh += "_aws"
+                print(f"[e2e/{p}/{q}]:{CI_BASEURL_FORMAT.format(branch_name=brh)}")
+        else:
+            print(f"[e2e/{p}]:{CI_BASEURL_FORMAT.format(branch_name=p)}")
+
+
+if __name__ == "__main__":
+
+    main()