Merge branch '1.x' into robbie/misc-documentation-items

.eslintrc.js

@@ -1,3 +1,6 @@
+// Copyright (c) Laserfiche.
+// Licensed under the MIT License. See LICENSE.md in the project root for license information.
+
 require('@rushstack/eslint-config/patch/modern-module-resolution');
 module.exports = {
   extends: ['@microsoft/eslint-config-spfx/lib/profiles/react'],

.github/workflows/jekyll_gh_pages.yml

@@ -1,58 +1,61 @@
-# Sample workflow for building and deploying a Jekyll site to GitHub Pages
-name: Deploy SharePoint Integration Documentation
-
-on:
-  # Runs on pushes targeting the default branch
-  push:
-    branches: ['1.x']
-
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
-concurrency:
-  group: 'pages'
-  cancel-in-progress: false
-
-jobs:
-  # Build job
-  build:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Setup Pages
-        uses: actions/configure-pages@v3
-
-      - name: Move LaserficheSharePointIntegrationAppManifest.json
-        run: cp ./UserDocuments/LaserficheSharePointIntegrationAppManifest.json ./jekyll_files/docs/assets/LaserficheSharePointIntegrationAppManifest.json
-
-      - name: Build with Jekyll
-        uses: actions/jekyll-build-pages@v1
-        with:
-          source: ./jekyll_files
-          destination: ./_site
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v2
-
-  # Deployment job
-  deploy:
-    runs-on: ubuntu-latest
-    needs: build
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v2
+# Copyright (c) Laserfiche.
+# Licensed under the MIT License. See LICENSE in the project root for license information.
+
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy SharePoint Integration Documentation
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ['1.x']
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      - name: Move LaserficheSharePointIntegrationAppManifest.json
+        run: cp ./UserDocuments/LaserficheSharePointIntegrationAppManifest.json ./jekyll_files/docs/assets/LaserficheSharePointIntegrationAppManifest.json
+
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./jekyll_files
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+
+  # Deployment job
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.github/workflows/main.yml

@@ -1,58 +1,61 @@
-name: SPFx CI CD
-
-on:
-  push:
-    branches: ['\d+.x']
-  pull_request:
-    branches: ['\d+.x']
-
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-
-env:
-  packagePath: sharepoint/solution/LaserficheSharePointOnlineIntegration.sppkg
-  packagePathUserDocs: UserDocuments
-  fullVersion: 1.0.0.${{github.run_number}}
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Setup Node.js environment
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16.x
-
-      - name: Tag commit
-        uses: rickstaa/action-create-tag@v1
-        with:
-          tag: ${{env.fullVersion}}
-          commit_sha: ${{ github.sha }}
-          message: Workflow run ${{github.server_url}}/${{github.repository}}/actions/runs/${{ github.run_id}}
-
-      - name: replace config/package-solution.json version
-        run: sed -i 's/"1.0.0.0"/"${{env.fullVersion}}"/g' config/package-solution.json
-
-      - name: replace package.json version
-        run: sed -i 's/"1.0.0.0"/"${{env.fullVersion}}"/g' package.json
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Build solution
-        run: gulp build
-
-      - name: Bundle and package
-        run: |
-          gulp bundle --ship
-          gulp package-solution --ship
-
-      - name: Upload Build Package
-        uses: actions/upload-artifact@v3
-        with:
-          path: |
-            ${{ env.packagePath }}
-            ${{ env.packagePathUserDocs }}
+# Copyright (c) Laserfiche.
+# Licensed under the MIT License. See LICENSE in the project root for license information.
+
+name: SPFx CI CD
+
+on:
+  push:
+    branches: ['\d+.x']
+  pull_request:
+    branches: ['\d+.x']
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+env:
+  packagePath: sharepoint/solution/LaserficheSharePointOnlineIntegration.sppkg
+  packagePathUserDocs: UserDocuments
+  fullVersion: 1.0.0.${{github.run_number}}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - name: Tag commit
+        uses: rickstaa/action-create-tag@v1
+        with:
+          tag: ${{env.fullVersion}}
+          commit_sha: ${{ github.sha }}
+          message: Workflow run ${{github.server_url}}/${{github.repository}}/actions/runs/${{ github.run_id}}
+
+      - name: replace config/package-solution.json version
+        run: sed -i 's/"1.0.0.0"/"${{env.fullVersion}}"/g' config/package-solution.json
+
+      - name: replace package.json version
+        run: sed -i 's/"1.0.0.0"/"${{env.fullVersion}}"/g' package.json
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build solution
+        run: gulp build
+
+      - name: Bundle and package
+        run: |
+          gulp bundle --ship
+          gulp package-solution --ship
+
+      - name: Upload Build Package
+        uses: actions/upload-artifact@v3
+        with:
+          path: |
+            ${{ env.packagePath }}
+            ${{ env.packagePathUserDocs }}

.github/workflows/veracode_build.yml

@@ -1,52 +1,55 @@
-name: Veracode SPFx CI CD
-
-on:
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-  schedule:
-    - cron: '0 12 * * 6'
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-
-    - name: Checkout code
-      uses: actions/checkout@v3
-
-    - name: Setup Node.js environment
-      uses: actions/setup-node@v3
-      with:
-        node-version: 16.x
-
-    - name: Install dependencies
-      run: npm ci
-
-    - name: Build solution
-      run: gulp build
-
-    - name: 'create an empty ./veracode folder'
-      run: 'mkdir -p ./veracode'
-
-    - name: 'Compress SharePoint files'
-      run: tar -czvf ./veracode/sharepoint-integration.tar.gz ./lib
-
-
-    - name: Veracode Upload And Scan (Static Application Security Testing)
-      uses: veracode/[email protected]
-      with:
-        appname: 'SharePoint Integration'
-        createprofile: true
-        filepath: 'veracode'
-        vid: '${{ secrets.VERACODE_API_ID }}'
-        vkey: '${{ secrets.VERACODE_API_KEY }}'
-
-    - name: Run Veracode Software Composition Analysis (SCA)
-      env:
-        SRCCLR_API_TOKEN: ${{ secrets.SRCCLR_API_TOKEN }}
-      uses: veracode/[email protected]
-      with:
-        create-issues: false
-        allow-dirty: true
-        recursive: true
-
+# Copyright (c) Laserfiche.
+# Licensed under the MIT License. See LICENSE in the project root for license information.
+
+name: Veracode SPFx CI CD
+
+on:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+  schedule:
+    - cron: '0 12 * * 6'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Setup Node.js environment
+      uses: actions/setup-node@v3
+      with:
+        node-version: 16.x
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Build solution
+      run: gulp build
+
+    - name: 'create an empty ./veracode folder'
+      run: 'mkdir -p ./veracode'
+
+    - name: 'Compress SharePoint files'
+      run: tar -czvf ./veracode/sharepoint-integration.tar.gz ./lib
+
+
+    - name: Veracode Upload And Scan (Static Application Security Testing)
+      uses: veracode/[email protected]
+      with:
+        appname: 'SharePoint Integration'
+        createprofile: true
+        filepath: 'veracode'
+        vid: '${{ secrets.VERACODE_API_ID }}'
+        vkey: '${{ secrets.VERACODE_API_KEY }}'
+
+    - name: Run Veracode Software Composition Analysis (SCA)
+      env:
+        SRCCLR_API_TOKEN: ${{ secrets.SRCCLR_API_TOKEN }}
+      uses: veracode/[email protected]
+      with:
+        create-issues: false
+        allow-dirty: true
+        recursive: true
+

.vscode/extensions.json

@@ -2,6 +2,7 @@
   "recommendations": [
     "msjsdiag.debugger-for-chrome",
     "esbenp.prettier-vscode",
-    "bradlc.vscode-tailwindcss"
+    "bradlc.vscode-tailwindcss",
+    "epivision.vscode-file-header"
   ]
 }

.vscode/settings.json

@@ -9,5 +9,20 @@
     "**/lib-amd": true,
     "src/**/*.scss.ts": true
   },
-  "typescript.tsdk": ".\\node_modules\\typescript\\lib"
+  "typescript.tsdk": ".\\node_modules\\typescript\\lib",
+  "powerHeader.commentMode": "line",
+  "powerHeader.autoInsert.enable": true,
+  "powerHeader.autoInsert.allow": "all",
+  "powerHeader.template": "Copyright (c) <author>.\\nLicensed under the <licenseType> License. See LICENSE.md in the project root for license information.",
+  "powerHeader.variables": ["<author>='Laserfiche'", "<licenseType>='MIT'"],
+  "[html]": {
+    "powerHeader.commentMode": "block"
+  },
+  "[css]": {
+    "powerHeader.commentMode": "block"
+  },
+  "[markdown]": {
+    "powerHeader.commentMode": "block"
+  },
+  "powerHeader.autoInsert.languages": ["plaintext", "Log", "json"]
 }