WIP PR to help reviewing oauth-moodle-dev

.ci-macosx.sh

@@ -1,13 +1,43 @@
 #!/bin/sh
 
-set -e
+set -ex
+
+sw_vers
+system_profiler SPSoftwareDataType
+uname -a
 
 brew update
+
+# homebrew fails to upgrade python due to unlinking failure
+# (cf. https://github.com/actions/setup-python/issues/577 )
+rm -f /usr/local/bin/2to3
+rm -f /usr/local/bin/idle3
+rm -f /usr/local/bin/pydoc3
+rm -f /usr/local/bin/python3
+rm -f /usr/local/bin/python3-config
+rm -f /usr/local/bin/2to3-3.11
+rm -f /usr/local/bin/idle3.11
+rm -f /usr/local/bin/pydoc3.11
+rm -f /usr/local/bin/python3.11
+rm -f /usr/local/bin/python3.11-config
+rm -f /usr/local/lib/libtcl8.6.dylib
+rm -f /usr/local/lib/libtk8.6.dylib
+rm -f /usr/local/bin/go
+rm -f /usr/local/bin/gofmt
+
+brew upgrade
+
 brew install pkg-config
 brew install opam
 brew install libev
-opam init -y --compiler=4.05.0
+brew install lzlib
+brew install openssl
+opam init -y -a --bare
+
+opam switch create . ocaml-base-compiler --deps-only --locked -y -j 2 # -v
 eval $(opam env)
+make
+make opaminstall
 
-opam install -y -j 2 . --deps-only --locked
-make && make opaminstall
+# See src/main/linking_flags.sh
+make detect-libs

.dockerignore

@@ -1,4 +1,19 @@
-.git
-_obuild
-_opam
-www
+*
+# whitelist: ignore everything except:
+!src
+!static
+!translations
+!scripts
+!demo-repository
+
+!learn-ocaml.opam
+!learn-ocaml.opam.locked
+!learn-ocaml-client.opam
+!learn-ocaml-client.opam.locked
+
+!Makefile
+!dune-project
+!dune
+
+# ignore backup files
+**/*~

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,118 @@
+name: 'Bug report'
+description: 'Report a bug with the Learn-OCaml project.'
+title: 'Bug: '
+labels: ['kind: bug']
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report this bug!
+  - type: input
+    id: users
+    attributes:
+      label: 'Related user(s):'
+      description: '(other GitHub users involved, if applicable)'
+      placeholder: '@…, @…'
+  - type: textarea
+    id: related
+    attributes:
+      label: 'Related issue(s) or PR(s):'
+      description: '(if applicable)'
+      placeholder: |-
+        - #…
+        - #…
+  - type: dropdown
+    id: scopes
+    attributes:
+      label: 'Related project scope(s):'
+      description: '(you can select multiple choices)'
+      multiple: true
+      options:
+        - web-app UI
+        - teacher dashboard
+        - partition-view
+        - 'grading, test_lib'
+        - web API
+        - learn-ocaml-client
+        - build
+        - documentation
+        - other
+  - type: textarea
+    id: descr
+    attributes:
+      label: 'Bug description:'
+      description: 'A clear and concise description of what the bug is.'
+    validations:
+      required: true
+  - type: textarea
+    id: repro
+    attributes:
+      label: 'To reproduce:'
+      description: 'Steps to reproduce the behavior.'
+      placeholder: |-
+        1. Open …
+        1. Click on …
+        1. Then …
+  - type: textarea
+    id: expected
+    attributes:
+      label: 'Expected behavior:'
+      description: 'A clear and concise description of what you expected to happen.'
+  - type: input
+    id: learn-ocaml-version
+    attributes:
+      label: 'learn-ocaml --version'
+      description: '(if you used a released version)'
+  - type: input
+    id: commit
+    attributes:
+      label: 'git describe --long --always --abbrev=40 --tags'
+      description: '(if you compiled the code yourself)'
+  - type: dropdown
+    id: os
+    attributes:
+      label: 'What OS do you use?'
+      multiple: true
+      options:
+        - GNU/Linux
+        - MacOS
+        - Windows
+        - other
+    validations:
+      required: true
+  - type: input
+    id: distro
+    attributes:
+      label: 'What OS version/distribution do you use?'
+    validations:
+      required: true
+  - type: dropdown
+    id: browser
+    attributes:
+      label: 'What browser(s) do you use with learn-ocaml?'
+      description: '(you can select multiple choices)'
+      multiple: true
+      options:
+        - Firefox
+        - Chromium
+        - Chrome
+        - Safari 
+        - Edge
+        - other
+  - type: input
+    id: browser-version
+    attributes:
+      label: 'What browser(s) version did you used to reproduce the issue?'
+      description: >-
+        (you can omit this question if the issue doesn't involve the web-app)
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: 'Screenshots (if need be):'
+      description: 'If applicable, add screenshots to document your problem.'
+  - type: textarea
+    id: context
+    attributes:
+      label: 'Additional context:'
+      description: 'Add any other useful details about the problem here.'

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+blank_issues_enabled: true
+
+contact_links:
+  - name: 'Share feedback as an Learn-OCaml teacher or learner'
+    url: https://github.com/learn-ocaml-community/teaching-feedback/issues/new/choose
+    about: >-
+      This is a new place to share questions and feedback within the learn-ocaml-community organization.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,65 @@
+name: 'Feature request'
+description: 'Suggest an idea for the Learn-OCaml project.'
+title: 'Feature: '
+labels: ['kind: feature']
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to open this issue!
+  - type: input
+    id: users
+    attributes:
+      label: 'Related user(s):'
+      description: '(other GitHub users involved, if applicable)'
+      placeholder: '@…, @…'
+  - type: textarea
+    id: related
+    attributes:
+      label: 'Related issue(s) or PR(s):'
+      description: '(if applicable)'
+      placeholder: |-
+        - #…
+        - #…
+  - type: dropdown
+    id: scopes
+    attributes:
+      label: 'Related project scope(s):'
+      description: '(you can select multiple choices)'
+      multiple: true
+      options:
+        - web-app UI
+        - teacher dashboard
+        - partition-view
+        - 'grading, test_lib'
+        - web API
+        - learn-ocaml-client
+        - build
+        - documentation
+        - other
+  - type: textarea
+    id: descr
+    attributes:
+      label: 'The problem:'
+      description: 'A clear and concise description of what the problem is.'
+      placeholder: >-
+        (e.g., I'm always frustrated when …)
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: 'Wanted solution:'
+      description: 'A clear and concise description of what you want to happen.'
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: 'Considered alternatives:'
+      description: >-
+        A clear and concise description of any alternative solutions or features you considered.
+  - type: textarea
+    id: context
+    attributes:
+      label: 'Additional context:'
+      description: 'Add any other useful details about the problem here.'

.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,92 @@
+name: Question
+description: 'Ask a question about the Learn-OCaml project.'
+title: 'Question: '
+labels: ['kind: question']
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to ask this question!
+  - type: input
+    id: users
+    attributes:
+      label: 'Related user(s):'
+      description: '(other GitHub users involved, if applicable)'
+      placeholder: '@…, @…'
+  - type: textarea
+    id: related
+    attributes:
+      label: 'Related issue(s) or PR(s):'
+      description: '(if applicable)'
+      placeholder: |-
+        - #…
+        - #…
+  - type: dropdown
+    id: scopes
+    attributes:
+      label: 'Related project scope(s):'
+      description: '(you can select multiple choices)'
+      multiple: true
+      options:
+        - web-app UI
+        - teacher dashboard
+        - partition-view
+        - 'grading, test_lib'
+        - web API
+        - learn-ocaml-client
+        - build
+        - documentation
+        - other
+  - type: textarea
+    id: descr
+    attributes:
+      label: 'Question?'
+      description: 'A clear and concise description of what you want to know.'
+    validations:
+      required: true
+  - type: textarea
+    id: tested
+    attributes:
+      label: 'What has already been tested:'
+      description: 'A clear and concise description of what you have already tried.'
+  - type: input
+    id: learn-ocaml-version
+    attributes:
+      label: 'learn-ocaml --version'
+      description: '(if you used a released version)'
+  - type: input
+    id: commit
+    attributes:
+      label: 'git describe --long --always --abbrev=40 --tags'
+      description: '(if you compiled the code yourself)'
+  - type: dropdown
+    id: os
+    attributes:
+      label: 'What OS do you use?'
+      multiple: true
+      options:
+        - GNU/Linux
+        - MacOS
+        - Windows
+        - other
+    validations:
+      required: true
+  - type: dropdown
+    id: browser
+    attributes:
+      label: 'What browser(s) do you use with learn-ocaml?'
+      description: '(you can select multiple choices)'
+      multiple: true
+      options:
+        - Firefox
+        - Chromium
+        - Chrome
+        - Safari 
+        - Edge
+        - other
+  - type: textarea
+    id: context
+    attributes:
+      label: 'Additional context:'
+      description: 'Add any other useful details or screenshots about the inquiry here.'

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,38 @@
+* **Kind:** bugfix / enhancement / feature
+
+<!-- For a bug fix, make sure the bug was already reported in an issue. -->
+
+* Close #…
+
+### Description
+
+<!-- Please recap the motivation and/or implementation choices for this change. -->
+
+### Checklist
+
+<!-- You can remove all the check-boxes that are not applicable. -->
+
+* [ ] Read the [CONTRIBUTING.md](https://github.com/ocaml-sf/learn-ocaml/blob/master/CONTRIBUTING.md) guide and:
+  * [ ] Use [Atomic Commits](https://github.com/ocaml-sf/learn-ocaml/blob/master/CONTRIBUTING.md#atomic-commits) so each commit gathers a single logical change
+  * [ ] Use [Conventional Commits](https://github.com/ocaml-sf/learn-ocaml/blob/master/CONTRIBUTING.md#conventional-commits) regarding commit messages (needed by our release toolchain)
+* [ ] Add/update [tests](https://github.com/ocaml-sf/learn-ocaml/tree/master/tests#readme)
+  <!-- if the change impacts the grading feature. -->
+* [ ] Add/update [documentation](https://github.com/ocaml-sf/learn-ocaml/tree/master/docs)
+  <!-- if there are some user-facing changes. -->
+* [ ] …
+  <!-- you can add more items to summarize what remains to do. -->
+
+<!-- You can leave this note below as a reminder for maintainers: -->
+### Note to maintainers
+
+* Read [this wiki page](https://github.com/ocaml-sf/learn-ocaml/wiki/Checklist-for-testing-and-merging-a-PR).
+* Make sure the PR has a **milestone**.
+* ***Assign*** yourself before merging.
+* [ ] Either do a regular **merge**:
+  * for PRs containing *several commits* following [conventional-commits](https://github.com/ocaml-sf/learn-ocaml/blob/master/CONTRIBUTING.md#conventional-commits),
+  * or for PRs containing 1 commit shared with a later PR (to preserve the SHA1)
+* [ ] Or do a **squash-merge**:
+  * for PRs containing *only 1 commit* (not shared with a later PR),
+  * or for PRs containing several commits that need not be kept in the history;
+  * → ***Update the commit message header*** with a [conventional-commit type](https://github.com/ocaml-sf/learn-ocaml/blob/master/CONTRIBUTING.md#conventional-commits-examples),
+  * → ***Add a footer*** `Close #…` if a related issue exists.