Updates on docs

Author: AlexRogalskiy

.github/workflows/lint-md.yml

@@ -0,0 +1,14 @@
+name: Check Markdown links
+
+on:
+  pull_request:
+    paths:
+      - '**.md'
+
+jobs:
+  lint-md:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: npm install
+      - run: npx remark --use validate-links --frail . .github

.github/workflows/support-window.yml

@@ -0,0 +1,47 @@
+name: Update support window diagram
+
+on:
+  # When our dependencies change
+  push:
+    paths:
+      - .github/workflows/support-window.yml
+      - package.json
+      - scripts/support-window.ts
+  # Manually, when TypeScript is released
+  # https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow
+  workflow_dispatch:
+
+jobs:
+  support-window:
+    if: github.repository == 'AlexRogalskiy/java-patterns'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        #with:
+        #  cache: npm
+      - run: npm install
+      - name: Fetch TypeScript versions and release dates from npm
+        run: |
+          npm view --json typescript time |
+            jq '
+              to_entries
+              # Earliest non-pre-release <major>.<minor>
+              | map(
+                (.key |= capture("^(?<version>[0-9]+\\.[0-9]+)\\.[0-9]+$").version)
+                | select(.key)
+              )
+              | unique_by(.key)
+              | from_entries
+            ' > docs/support-window.json
+      - name: Make SVG diagram
+        run: node --experimental-json-modules scripts/support-window > docs/support-window.svg
+      - run: git add docs/support-window.json docs/support-window.svg
+      - run: git config user.name .github/workflows/support-window.yml
+      - run: git config user.email bot@typescriptlang.org
+      - run: |
+          git diff --quiet --cached ||
+          git commit \
+            --message "[README] 🤖 Update support window diagram" \
+            --message "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID" \
+      - run: git push

.gitignore

@@ -50,6 +50,7 @@ pids
 # Build and temp folders
 .settings/
 .idea/
+.cache/
 .reporting/
 bin/
 tmp/

.mergify.yml

@@ -1,15 +1,17 @@
 pull_request_rules:
-  - name: "approve automated PRs that have passed checks"
+  - name: 'approve automated PRs that have passed checks'
     conditions:
-      - "#files<=6"
-      - "base=master"
+      - '#files<=6'
+      - 'base=master'
     actions:
       review:
-        type: "APPROVE"
-        message: "We've automatically approved this PR because the checks from the automated Pull Request have passed."
+        type: 'APPROVE'
+        message:
+          "We've automatically approved this PR because the checks from the
+          automated Pull Request have passed."
       label:
         add:
-          - "auto-approved"
+          - 'auto-approved'
 
   - name: automatic merge on CI success require review
     conditions:
@@ -52,8 +54,8 @@ pull_request_rules:
       merge:
         method: merge
         strict: false
-      dismiss_reviews: { }
-      delete_head_branch: { }
+      dismiss_reviews: {}
+      delete_head_branch: {}
 
   - name: automatic merge on CI success for TemplateControl
     conditions:
@@ -69,7 +71,7 @@ pull_request_rules:
     conditions:
       - merged
     actions:
-      delete_head_branch: { }
+      delete_head_branch: {}
 
   - name: Automatically approve Dependabot PRs
     conditions:
@@ -83,24 +85,26 @@ pull_request_rules:
       review:
         type: APPROVE
 
-  - name: "delete the head branch after merge"
+  - name: 'delete the head branch after merge'
     conditions:
-      - "merged"
+      - 'merged'
     actions:
-      delete_head_branch: { }
+      delete_head_branch: {}
 
-  - name: "ask to resolve conflict"
+  - name: 'ask to resolve conflict'
     conditions:
-      - "conflict"
+      - 'conflict'
     actions:
       comment:
-        message: "This pull request now has conflicts. Could you fix it @{{author}}? 🙏"
+        message:
+          'This pull request now has conflicts. Could you fix it @{{author}}? 🙏'
 
-  - name: "remove outdated reviews"
+  - name: 'remove outdated reviews'
     conditions:
-      - "base=master"
+      - 'base=master'
     actions:
       dismiss_reviews:
         changes_requested: true
         approved: true
-        message: "This Pull Request has been updated, so we're dismissing all reviews."
+        message:
+          "This Pull Request has been updated, so we're dismissing all reviews."

.nodemonignore

@@ -0,0 +1,2 @@
+/.git/*
+*.backup

.npmrc

@@ -4,10 +4,10 @@ init-author-url=http://sensiblemetrics.io
 init-version=0.0.0
 init-license=MIT
 
-scripts-prepend-node-path=true
-
 registry=https://registry.npmjs.org/
 tag-version-prefix=""
+
 package-lock=false
 save-exact=false
 legacy-peer-deps=true
+scripts-prepend-node-path=auto

.nvmrc

@@ -1 +1 @@
-16.14.2
+17.1.0

codecov.yml

@@ -1,24 +1,28 @@
+# validate this file:
+#   curl --data-binary @.codecov.yml https://codecov.io/validate
+
 codecov:
   require_ci_to_pass: true
 
 coverage:
   precision: 2
   round: down
-  range:
-    - 70.0
-    - 100.0
+  range: '70.0 - 100.0'
   status:
     changes: false
     project:
       default:
         informational: true
+        threshold: 1%
+        if_not_found: success # no commit found? still set a success
     patch:
       default:
         informational: true
+        if_not_found: success
 
 parsers:
   javascript:
-    enable_partials: false
+    enable_partials: yes
   gcov:
     branch_detection:
       conditional: yes

distribution/docker-images/dev.Dockerfile

@@ -57,9 +57,12 @@ ARG DATA_DIR="/usr/src/data"
 ARG TEMP_DIR="${TEMP_DIR:-/tmp}"
 
 ARG INSTALL_PACKAGES="git curl tini dos2unix locales"
+ARG INSTALL_OPTIONS="--assume-yes --no-install-recommends --only-upgrade"
 
 ## setup image labels
-LABEL "com.github.image.title"="$IMAGE_NAME" \
+LABEL "name"="$IMAGE_NAME" \
+      "version"="$IMAGE_VERSION" \
+      "com.github.image.title"="$IMAGE_NAME" \
       "com.github.image.description"="$IMAGE_DESCRIPTION" \
       "com.github.image.vendor"="$IMAGE_VENDOR" \
       "com.github.image.url"="$IMAGE_URL" \
@@ -72,7 +75,7 @@ LABEL "com.github.image.title"="$IMAGE_NAME" \
       "com.github.image.created"="$IMAGE_BUILD_DATE"
 
 ## setup shell options
-SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+SHELL ["/bin/bash", "-exo", "pipefail", "-c"]
 
 ## setup environment variables
 ENV PYTHON_VERSION=$PYTHON_VERSION \
@@ -82,16 +85,16 @@ ENV PYTHON_VERSION=$PYTHON_VERSION \
 
 ENV DEBIAN_FRONTEND=noninteractive \
     TERM="xterm" \
+    PAGER=cat \
     TZ=UTC \
     LC_ALL="en_US.UTF-8" \
     LANG=$LC_ALL \
-    LANGUAGE=$LC_ALL \
-    LC_CTYPE=$LC_ALL
+    LANGUAGE="en_US:en" \
+    LC_CTYPE=$LC_ALL \
     PYTHONIOENCODING=UTF-8 \
     PYTHONLEGACYWINDOWSSTDIO=UTF-8 \
     PYTHONUNBUFFERED=1 \
     PYTHONDONTWRITEBYTECODE=1 \
-    DEBIAN_FRONTEND=noninteractive \
     APT_KEY_DONT_WARN_ON_DANGEROUS_USAGE=1 \
     PIP_DISABLE_PIP_VERSION_CHECK=1 \
     PIP_NO_CACHE_DIR=1 \
@@ -101,7 +104,7 @@ ENV DEBIAN_FRONTEND=noninteractive \
     NODE_NO_WARNINGS='1' \
     NODE_TLS_REJECT_UNAUTHORIZED='0' \
     NODE_OPTIONS="--max-old-space-size=8192" \
-    IN_DOCKER=true
+    IN_DOCKER=True
 
 ENV USER=${USER:-'devbot'} \
     UID=${UID:-5000} \
@@ -118,6 +121,11 @@ RUN adduser \
     "$USER" \
     || exit 0
 
+# Run commands as user
+RUN whoami && \
+	# opt-out of the new security feature, not needed in a CI environment
+	git config --global --add safe.directory '*'
+
 ## mount volumes
 VOLUME ["$APP_DIR", "$DATA_DIR", "$TEMP_DIR"]
 
@@ -129,7 +137,7 @@ RUN echo "**** Installing build packages ****"
 ## RUN echo "deb http://archive.ubuntu.com/ubuntu precise main universe" > /etc/apt/sources.list
 RUN apt-get update \
     && apt-get upgrade -yqq \
-    && apt-get install --assume-yes --no-install-recommends --only-upgrade $INSTALL_PACKAGES 2>&1 > /dev/null \
+    && apt-get install $INSTALL_OPTIONS $INSTALL_PACKAGES 2>&1 > /dev/null \
     && apt-get -yqq autoclean \
     && apt-get -yqq clean \
     && apt-get -yqq autoremove \