[pull] main from jef:main

.dockerignore

@@ -3,4 +3,5 @@
 .vs/
 .vscode/
 build/
+docs/
 node_modules/

.github/ISSUE_TEMPLATE/bug-report.yaml

@@ -0,0 +1,54 @@
+name: 🐛 Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels:
+  - 'type: bug'
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+      placeholder: Tell us what you see!
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Current Behavior
+      description: What happened?
+      placeholder: Tell us what you see!
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: What operating system are you seeing the problem on?
+      multiple: true
+      options:
+        - Linux
+        - Windows
+        - macOS
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Configuration
+      description: Please copy and paste your `dotenv`. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/jef/streetmerchant/blob/main/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/feature-request.yaml

@@ -0,0 +1,41 @@
+name: 🚀 Feature Request
+description: Formalize a feature request from GitHub Discussions
+title: "[Feature]: "
+labels:
+  - 'type: feature'
+body:
+  - type: textarea
+    attributes:
+      label: Proposed solution
+      description: What is solution to this feature request?
+      placeholder: Solution description.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Objective
+      description: Link to discussion.
+      placeholder: https://github.com/jef/streetmerchant/discussions
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Goals
+      description: What is the purpose of feature request?
+      placeholder: Add all relevant goals.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Non-goals
+      description: What else could be accomplished with this feature request, but is currently out of scope?
+      placeholder: Add all relevant non-goals.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Anti-goals
+      description: What could go wrong (side effects) if we implement this feature request?
+      placeholder: Add all relevant anti-goals.
+    validations:
+      required: true

.github/workflows/ci.yaml

@@ -3,38 +3,37 @@ on:
   pull_request:
     branches:
       - main
-  push:
-    branches:
-      - main
 jobs:
-  build-lint:
+  build_lint:
     name: Build and lint
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Setup Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
-          node-version: 16.6.1
-      - name: Setup build cache
-        uses: actions/cache@v2
+          node-version: 16.18.0
+      - name: Cache node modules
+        id: cache_node_modules
+        uses: actions/cache@v3
         with:
-          path: ~/.npm
+          path: node_modules
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
           restore-keys: ${{ runner.os }}-node-
-      - name: Install dependencies
+      - name: Install Dependencies
+        if: steps.cache_node_modules.outputs.cache-hit != 'true'
         run: npm ci
       - name: Compile TypeScript
         run: npm run compile
       - name: Run linter
         run: npm run lint
-  build-docker:
+  build_docker:
     name: Build Docker image
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Run paths filter
         uses: dorny/paths-filter@v2
         id: filter

.github/workflows/documentation.yaml

@@ -4,14 +4,14 @@ on:
     branches:
       - main
 jobs:
-  build-deploy:
+  build_deploy:
     name: Build and publish documentation
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Setup Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
           python-version: 3.x
       - name: Install Python packages

.github/workflows/nightly-release.yaml

@@ -4,35 +4,41 @@ on:
     - cron: '0 0 * * *'
   workflow_dispatch: {}
 jobs:
-  check-date:
-    name: Check dates
+  check_code_change:
+    name: Check code change
     runs-on: ubuntu-latest
     outputs:
-      should-run: ${{ steps.code-change.outputs.should-run }}
+      should_run: ${{ steps.code_change.outputs.should_run }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Check if code has changed with 24 hours
         continue-on-error: true
-        id: code-change
+        id: code_change
         run: |
-          [[ $(git rev-list --after="24 hours" --first-parent HEAD) ]] && echo "::set-output name=should-run::true"
-  build-release:
-    name: Build and release Docker image
+          if [[ $(git rev-list --after="24 hours" --first-parent HEAD) ]]; then
+            echo "should_run=true" >> $GITHUB_OUTPUT
+          fi
+  build_tag_publish:
+    name: Build, tag and publish Docker image
     runs-on: ubuntu-latest
-    needs: check-date
-    if: needs.check-date.outputs.should-run == 'true'
+    needs: check_code_change
+    if: needs.check_code_change.outputs.should_run == 'true'
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
-      - name: Login into GitHub Container Registry
-        run: echo ${{ secrets.CR_PAT }} | docker login ghcr.io -u $GITHUB_ACTOR --password-stdin
-      - name: Build Docker image
-        run: |
-          docker build \
-          -t "ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_SHA:0:7}" \
-          -t "ghcr.io/${GITHUB_REPOSITORY}:nightly" .
-      - name: Release Docker image
-        run: |
-          docker push "ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_SHA:0:7}"
-          docker push "ghcr.io/${GITHUB_REPOSITORY}:nightly"
+        uses: actions/checkout@v3
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Get short SHA
+        id: short_sha
+        run: echo "short_sha=${GITHUB_SHA::7}" >> "$GITHUB_OUTPUT"
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true
+          tags: "ghcr.io/jef/streetmerchant:nightly,ghcr.io/jef/streetmerchant:${{ steps.short_sha.outputs.short_sha }}"

.github/workflows/pr-lint.yaml

@@ -10,9 +10,10 @@ jobs:
   lint-pr:
     name: Lint pull request title
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
     steps:
       - name: Lint pull request title
         uses: jef/conventional-commits-pr-action@v1
         with:
-          comment: false
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yaml

@@ -4,31 +4,48 @@ on:
     branches:
       - main
 jobs:
-  build-tag-release:
-    name: Build, tag, and release Docker image
+  release:
+    name: Create release
     runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+      tag_name_no_v: ${{ steps.normalize_tag.outputs.tag_name_no_v }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
-      - name: Setup release please
-        uses: google-github-actions/release-please-action@v2
+        uses: actions/checkout@v3
+      - name: Run release-please
+        uses: google-github-actions/release-please-action@v3
         id: release
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           release-type: node
           changelog-path: CHANGELOG.md
           package-name: streetmerchant
-      - name: Login into GitHub Container Registry
-        if: ${{ steps.release.outputs.release_created }}
-        run: echo ${{ secrets.CR_PAT }} | docker login ghcr.io -u $GITHUB_ACTOR --password-stdin
-      - name: Build Docker image
-        if: ${{ steps.release.outputs.release_created }}
+          changelog-types: '[{"type":"feat","section":"Features","hidden":false},{"type":"fix","section":"Bug Fixes","hidden":false},{"type":"chore","section":"Miscellaneous","hidden":false},{"type":"ci","section":"Continuous Integration","hidden":false},{"type":"docs","section":"Documentation","hidden":false},{"type":"refactor","section":"Refactoring","hidden":false},{"type":"perf","section":"Performance","hidden":false},{"type":"test","section":"Tests","hidden":false}]'
+      - name: Normalize tag name
+        if: steps.release.outputs.release_created == 'true'
+        id: normalize_tag
         run: |
-          docker build \
-          -t "ghcr.io/${GITHUB_REPOSITORY}:${{ steps.release.outputs.tag_name }}" \
-          -t "ghcr.io/${GITHUB_REPOSITORY}:latest" .
-      - name: Release Docker image
-        if: ${{ steps.release.outputs.release_created }}
-        run: |
-          docker push "ghcr.io/${GITHUB_REPOSITORY}:${{ steps.release.outputs.tag_name }}"
-          docker push "ghcr.io/${GITHUB_REPOSITORY}:latest"
+          tag=${{ steps.release.outputs.tag_name }}
+          echo "tag_name_no_v=${tag#v}" >> "$GITHUB_OUTPUT"
+  build_tag_publish:
+    name: Build, tag, and publish
+    runs-on: ubuntu-latest
+    needs: release
+    if: needs.release.outputs.release_created == 'true'
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true
+          tags: "ghcr.io/jef/streetmerchant:latest,ghcr.io/jef/streetmerchant:${{ needs.release.outputs.tag_name_no_v }}"

.github/workflows/stale.yaml

@@ -23,6 +23,6 @@ jobs:
           stale-pr-message: ${{ env.STALE_MESSAGE }}
         env:
           CLOSE_MESSAGE: 'This issue has been closed because it is stale. Reopen if necessary.'
-          EXEMPT_LABEL: 'priority: low,priority: normal, priority: high,status: help wanted,status: in progress,status: needs triage'
+          EXEMPT_LABEL: 'priority: low,priority: normal,priority: high,status: help wanted,status: in progress,status: needs triage'
           STALE_LABEL: 'status: stale'
           STALE_MESSAGE: 'This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 10 days'

.gitignore

@@ -9,6 +9,7 @@ node_modules/
 dotenv
 *.proxies
 success-*.png
+screenshots/
 
 *.wav
 *.mp3

.node-version

@@ -1 +1 @@
-16.6.1
+16.18.0