ci: check for change tag (tauri-apps#7149)

amrbashir · lucasfernog · web-flow · commit fc2e4083b0f1 · 2023-06-07T16:32:36.000+03:00
* ci: check for change tag

* fix workflow

* Update .scripts/ci/check-change-tags.js

* feat: also check if tag is known

seems like covector does not check that so we can do it here for now

* remove push run

* only check changed files

* add missing tag

---------

Co-authored-by: Lucas Fernandes Nogueira &lt;lucas@tauri.studio&gt;
diff --git a/.changes/api-js-os-locale.md b/.changes/api-js-os-locale.md
@@ -1,5 +1,5 @@
 ---
-'@tauri-apps/api': 'patch'
+'@tauri-apps/api': 'patch:feat'
 ---
 
 Add `locale` function in the `os` module to get the system locale.
diff --git a/.changes/api-rs-os-locale.md b/.changes/api-rs-os-locale.md
@@ -1,5 +1,5 @@
 ---
-"tauri": "patch"
+'tauri': 'patch:feat'
 ---
 
 Add `tauri::api::os::locale` function to get the system locale.
diff --git a/.changes/build-enhance-features-check.md b/.changes/build-enhance-features-check.md
@@ -1,5 +1,5 @@
 ---
-"tauri-build": patch
+'tauri-build': patch:enhance
 ---
 
 Enhance Cargo features check.
diff --git a/.changes/cleanup-app-bundle.md b/.changes/cleanup-app-bundle.md
@@ -1,5 +1,5 @@
 ---
-"tauri-bundler": patch
+'tauri-bundler': patch:enhance
 ---
 
 Remove macOS app bundles from the output if they are not requested by the user.
diff --git a/.changes/cli-windows-arm64.md b/.changes/cli-windows-arm64.md
@@ -1,6 +1,6 @@
 ---
-'tauri-cli': minor
-'@tauri-apps/cli': minor
+'tauri-cli': minor:feat
+'@tauri-apps/cli': minor:feat
 ---
 
 Provide prebuilt CLIs for Windows ARM64 targets.
diff --git a/.changes/config-require-literal_leading_dot.md b/.changes/config-require-literal_leading_dot.md
@@ -1,5 +1,5 @@
 ---
-'tauri-utils': 'minor'
+'tauri-utils': 'minor:feat'
 ---
 
 Add option to configure `require_literal_leading_dot` on `fs` and `asset` protcol scopes.
diff --git a/.changes/core-global-shortcut-panics.md b/.changes/core-global-shortcut-panics.md
@@ -1,6 +1,6 @@
 ---
-'tauri': 'patch'
-'tauri-runtime-wry': 'patch'
+'tauri': 'patch:bug'
+'tauri-runtime-wry': 'patch:bug'
 ---
 
 Fix panics when registering an invalid global shortcuts or checking it is registered and return proper errors instead.
diff --git a/.changes/core-window-config.md b/.changes/core-window-config.md
@@ -1,5 +1,5 @@
 ---
-'tauri': 'patch'
+'tauri': 'patch:bug'
 ---
 
 Fix some configurations not applied when creating the window through Javascript.
diff --git a/.changes/core-windows-notification-sound.md b/.changes/core-windows-notification-sound.md
@@ -1,5 +1,5 @@
 ---
-"tauri": "patch"
+'tauri': 'patch:bug'
 ---
 
 Play a sound when showing a notification on Windows.
diff --git a/.changes/deb-custom-desktop-file-config.md b/.changes/deb-custom-desktop-file-config.md
@@ -1,7 +1,7 @@
 ---
-"tauri-utils": patch
-"tauri-cli": patch
-"@tauri-apps/cli": patch
+'tauri-utils': patch:feat
+'tauri-cli': patch:feat
+'@tauri-apps/cli': patch:feat
 ---
 
 Added the `desktop_template` option on `tauri.conf.json > tauri > bundle > deb`.
diff --git a/.changes/enhance-allowlist-injection.md b/.changes/enhance-allowlist-injection.md
@@ -1,6 +1,6 @@
 ---
-"tauri-cli": patch
-"@tauri-apps/cli": patch
+'tauri-cli': patch:enhance
+'@tauri-apps/cli': patch:enhance
 ---
 
 Enhance injection of Cargo features.
diff --git a/.changes/expose-test.md b/.changes/expose-test.md
@@ -1,5 +1,5 @@
 ---
-"tauri": patch
+"tauri": 'minor:feat'
 ---
 
 Expose the `test` module behind the `test` Cargo feature.
diff --git a/.changes/mime-type.md b/.changes/mime-type.md
@@ -1,5 +1,5 @@
 ---
-'tauri-utils': 'patch'
+'tauri-utils': 'patch:feat'
 ---
 
 Add `MimeType::parse_with_fallback` and `MimeType::parse_from_uri_with_fallback`
diff --git a/.changes/nsis-custom-language-files.md b/.changes/nsis-custom-language-files.md
@@ -1,6 +1,6 @@
 ---
 'tauri-bundler': 'minor:feat'
-'tauri-utils': 'minor'
+'tauri-utils': 'minor:feat'
 'tauri-cli': 'minor:feat'
 ---
 
diff --git a/.changes/nsis-custom-template.md b/.changes/nsis-custom-template.md
@@ -1,5 +1,5 @@
 ---
-'tauri-utils': 'minor'
+'tauri-utils': 'minor:feat'
 'tauri-bundler': 'minor:feat'
 'tauri-cli': 'minor:feat'
 '@tauri-apps/cli': 'minor:feat'
diff --git a/.changes/nsis-downgrades.md b/.changes/nsis-downgrades.md
@@ -1,5 +1,5 @@
 ---
-'tauri-bundler': 'patch'
+'tauri-bundler': 'patch:bug'
 ---
 
 Fix NSIS installer disabling `do not uninstall` button and silent installer aborting, if `allowDowngrades` was disabled even when we are not downgrading.
diff --git a/.changes/nsis-install-mode-args.md b/.changes/nsis-install-mode-args.md
@@ -1,5 +1,5 @@
 ---
-'tauri-utils': 'patch'
+'tauri-utils': 'patch:feat'
 ---
 
 Add `WindowsUpdateInstallMode::nsis_args`
diff --git a/.changes/nsis-passive-mode.md b/.changes/nsis-passive-mode.md
@@ -1,5 +1,5 @@
 ---
-'tauri': 'minor'
+'tauri': 'minor:enhance'
 ---
 
 Support `passive` mode for NSIS updater.
diff --git a/.changes/nsis-restart-flag.md b/.changes/nsis-restart-flag.md
@@ -1,5 +1,5 @@
 ---
-'tauri-bundler': 'minor'
+'tauri-bundler': 'minor:feat'
 ---
 
 For NSIS, Add support for `/P` to install or uninstall in passive mode, `/R` to (re)start the app and `/NS` to disable creating shortcuts in `silent` and `passive` modes.
diff --git a/.changes/nsis-silent-kill.md b/.changes/nsis-silent-kill.md
@@ -1,5 +1,5 @@
 ---
-'tauri-bundler': 'minor'
+'tauri-bundler': 'minor:enhance'
 ---
 
 NSIS `silent` and `passive` installer/updater will auto-kill the app if its running.
diff --git a/.changes/nsis-silent-shortcuts.md b/.changes/nsis-silent-shortcuts.md
@@ -1,5 +1,5 @@
 ---
-'tauri-bundler': 'patch'
+'tauri-bundler': 'patch:bug'
 ---
 
 Fix NSIS silent installer not creating Desktop and StartMenu shortcuts. Pass `/NS` to disable creating them.
diff --git a/.changes/nsis-uninstall-wix.md b/.changes/nsis-uninstall-wix.md
@@ -1,5 +1,5 @@
 ---
-'tauri-bundler': 'minor'
+'tauri-bundler': 'minor:enhance'
 ---
 
 NSIS installer will now check if a previous WiX `.msi` installation exist and will prompt users to uninstall it.
diff --git a/.changes/remove-attohttpc-bundler.md b/.changes/remove-attohttpc-bundler.md
@@ -1,5 +1,5 @@
 ---
-'tauri-bundler': patch
+'tauri-bundler': patch:enhance
 ---
 
 Remove `attohttpc` in favor of `ureq`.
diff --git a/.changes/remove-attohttpc-core.md b/.changes/remove-attohttpc-core.md
@@ -1,5 +1,5 @@
 ---
-'tauri': patch
+'tauri': patch:enhance
 ---
 
 Remove `attohttpc` in favor of `reqwest`.
diff --git a/.changes/rustls-default.md b/.changes/rustls-default.md
@@ -1,6 +1,6 @@
 ---
-'tauri-cli': patch
-'@tauri-apps/cli': patch
+'tauri-cli': patch:enhance
+'@tauri-apps/cli': patch:enhance
 ---
 
 Add `rustls` as default Cargo feature.
diff --git a/.changes/txt-mime-type.md b/.changes/txt-mime-type.md
@@ -1,5 +1,5 @@
 ---
-"tauri-utils": patch
+'tauri-utils': patch:feat
 ---
 
 Correctly determine MIME type of `.txt` files.
diff --git a/.github/workflows/check-change-tags.yml b/.github/workflows/check-change-tags.yml
@@ -0,0 +1,32 @@
+# Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-License-Identifier: MIT
+
+name: check change tags
+
+on:
+  pull_request:
+    paths:
+      - '.changes/*.md'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: dorny/paths-filter@v2
+        id: filter
+        with:
+          list-files: shell
+          filters: |
+            changes:
+              - '.changes/*.md'
+
+      - name: check
+        run: node ./.scripts/ci/check-change-tags.js ${{ steps.filter.outputs.changes_files }}
+        if: ${{ steps.filter.outputs.changes == 'true' }}
diff --git a/.github/workflows/check-generated-files.yml b/.github/workflows/check-generated-files.yml
@@ -13,16 +13,6 @@ on:
       - 'core/tauri-utils/src/config.rs'
       - 'tooling/cli/schema.json'
       - 'core/tauri-config-schema/schema.json'
-  push:
-    branches:
-      - dev
-    paths:
-      - '.github/workflows/check-generated-files.yml'
-      - 'tooling/api/src/**'
-      - 'core/tauri/scripts/bundle.global.js'
-      - 'core/tauri-utils/src/config.rs'
-      - 'tooling/cli/schema.json'
-      - 'core/tauri-config-schema/schema.json'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
diff --git a/.github/workflows/check-license-header.yml b/.github/workflows/check-license-header.yml
@@ -25,4 +25,4 @@ jobs:
               - added: '**'
       - name: check header license on new files
         if: ${{ steps.filter.outputs.added == 'true' }}
-        run: node check-license-header.js ${{ steps.filter.outputs.added_files }}
+        run: node ./.scripts/ci/check-license-header.js ${{ steps.filter.outputs.added_files }}
diff --git a/.scripts/cargo-check.ps1 b/.scripts/cargo-check.ps1
@@ -1,4 +1,5 @@
 #!/usr/bin/env pwsh
+
 # Copyright 2019-2023 Tauri Programme within The Commons Conservancy
 # SPDX-License-Identifier: Apache-2.0
 # SPDX-License-Identifier: MIT
diff --git a/.scripts/cargo-check.sh b/.scripts/cargo-check.sh
@@ -1,4 +1,5 @@
 #!/usr/bin/env sh
+
 # Copyright 2019-2023 Tauri Programme within The Commons Conservancy
 # SPDX-License-Identifier: Apache-2.0
 # SPDX-License-Identifier: MIT
diff --git a/.scripts/ci/check-change-tags.js b/.scripts/ci/check-change-tags.js
@@ -0,0 +1,79 @@
+#!/usr/bin/env node
+
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+const fs = require('fs')
+const path = require('path')
+const ignorePackages = [
+  'tauri-macros',
+  'tauri-codegen',
+  'tauri-runtime',
+  'tauri-runtime-wry',
+  'tauri-driver'
+]
+
+const covectorConfig = JSON.parse(
+  fs.readFileSync('.changes/config.json', 'utf8')
+)
+const tags = Object.keys(covectorConfig.changeTags)
+
+const missingTagsFiles = {}
+const unknownTagsFiles = {}
+
+function checkChangeFiles(changeFiles) {
+  for (const file of changeFiles) {
+    const content = fs.readFileSync(file, 'utf8')
+    const [frontMatter] = /^---[\s\S.]*---\n/i.exec(content)
+    const packages = frontMatter
+      .split('\n')
+      .filter((l) => !(l === '---' || !l))
+      .map((l) => l.replace(/('|")/g, '').split(':'))
+
+    for (const [package, _, tag] of packages) {
+      if (!tag) {
+        if (ignorePackages.includes(package)) continue
+
+        if (!missingTagsFiles[file]) missingTagsFiles[file] = []
+        missingTagsFiles[file].push(package)
+      } else if (!tags.includes(tag)) {
+        if (!unknownTagsFiles[file]) unknownTagsFiles[file] = []
+        unknownTagsFiles[file].push({ package, tag })
+      }
+    }
+  }
+  const missingTagsEntries = Object.entries(missingTagsFiles)
+  const unknownTagsEntries = Object.entries(unknownTagsFiles)
+  if (missingTagsEntries.length > 0 || unknownTagsEntries.length > 0) {
+    for (const [file, packages] of missingTagsEntries) {
+      for (const package of packages) {
+        console.error(
+          `Package \`${package}\` is missing a change tag in ${file} `
+        )
+      }
+    }
+
+    for (const [file, packages] of unknownTagsEntries) {
+      for (const { package, tag } of packages) {
+        console.error(
+          `Package \`${package}\` has an uknown change tag ${tag} in ${file} `
+        )
+      }
+    }
+
+    process.exit(1)
+  }
+}
+
+const [_bin, _script, ...files] = process.argv
+
+if (files.length > 0) {
+  checkChangeFiles(files.filter((f) => f.toLowerCase() !== 'readme.md'))
+} else {
+  const changeFiles = fs
+    .readdirSync('.changes')
+    .filter((f) => f.endsWith('.md') && f.toLowerCase() !== 'readme.md')
+    .map((p) => path.join('.changes', p))
+  checkChangeFiles(changeFiles)
+}
diff --git a/.scripts/ci/check-license-header.js b/.scripts/ci/check-license-header.js
@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 // Copyright 2019-2023 Tauri Programme within The Commons Conservancy
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
@@ -9,13 +11,22 @@ const readline = require('readline')
 const header = `Copyright 2019-2023 Tauri Programme within The Commons Conservancy
 SPDX-License-Identifier: Apache-2.0
 SPDX-License-Identifier: MIT`
-const bundlerLicense = '// Copyright 2016-2019 Cargo-Bundle developers <https://github.com/burtonageo/cargo-bundle>'
+const bundlerLicense =
+  '// Copyright 2016-2019 Cargo-Bundle developers <https://github.com/burtonageo/cargo-bundle>'
 
 const extensions = ['.rs', '.js', '.ts', '.yml']
-const ignore = ['target', 'templates', 'node_modules', 'gen', 'dist', 'bundle.js', 'bundle.global.js']
+const ignore = [
+  'target',
+  'templates',
+  'node_modules',
+  'gen',
+  'dist',
+  'bundle.js',
+  'bundle.global.js'
+]
 
 async function checkFile(file) {
-  if (extensions.some(e => file.endsWith(e))) {
+  if (extensions.some((e) => file.endsWith(e))) {
     const fileStream = fs.createReadStream(file)
     const rl = readline.createInterface({
       input: fileStream,
@@ -26,7 +37,11 @@ async function checkFile(file) {
     let i = 0
     for await (let line of rl) {
       // ignore empty lines, allow shebang and bundler license
-      if (line.length === 0 || line.startsWith("#!") || line === bundlerLicense) {
+      if (
+        line.length === 0 ||
+        line.startsWith('#!') ||
+        line === bundlerLicense
+      ) {
         continue
       }
 
@@ -93,7 +108,7 @@ if (files.length > 0) {
 
   run()
 } else {
-  check('.').then(missing => {
+  check('.').then((missing) => {
     if (missing.length > 0) {
       console.log(missing.join('\n'))
       process.exit(1)
diff --git a/.scripts/ci/has-diff.sh b/.scripts/ci/has-diff.sh
diff --git a/.scripts/ci/pack-cli.sh b/.scripts/ci/pack-cli.sh
diff --git a/.scripts/covector/package-latest-version.js b/.scripts/covector/package-latest-version.js
diff --git a/.scripts/covector/sync-cli-metadata.js b/.scripts/covector/sync-cli-metadata.js
diff --git a/.scripts/docker/build.sh b/.scripts/docker/build.sh
diff --git a/.scripts/setup.ps1 b/.scripts/setup.ps1
diff --git a/.scripts/setup.sh b/.scripts/setup.sh
diff --git a/.scripts/update-lockfiles.sh b/.scripts/update-lockfiles.sh
diff --git a/.scripts/utils/batch_to_exe.cmd b/.scripts/utils/batch_to_exe.cmd
