chore(dev): review the release process

includes fixes to the nu script and updates to the git-cliff config

Author: 2bndy5

.config/cliff.toml

@@ -28,8 +28,10 @@ body = """
 
         > {{ message }}
     {%- endif %}
-{% else -%}
+{% elif previous.timestamp -%}
     ## [{{ UNRELEASED }}] - {{ previous.timestamp | date(format="%Y-%m-%d") }} to present
+{% else -%}
+    ## [{{ UNRELEASED }}]
 {% endif -%}
 
 {% for group, commits in commits | group_by(attribute="group") %}
@@ -45,14 +47,19 @@ body = """
     {% endfor %}
 {% endfor -%}
 
-{% set first_commit = previous.version -%}
-{%- set last_commit = "HEAD" -%}
 {% if version -%}
+    {#- Use the current version tag as the latest commit -#}
     {%- set last_commit = version -%}
-    {%- if not previous.version -%}
-        {#- If this is the first versioned release, use the initial commit -#}
-        {%- set first_commit = init_commit -%}
-    {%- endif -%}
+{%- else -%}
+    {#- Otherwise, just call it HEAD -#}
+    {%- set last_commit = "HEAD" -%}
+{%- endif -%}
+{%- if not previous.version -%}
+    {#- If this is the first versioned release, use the initial commit -#}
+    {%- set first_commit = init_commit -%}
+{%- else -%}
+    {#- Otherwise, use the previous version tag as the starting point -#}
+    {%- set first_commit = previous.version -%}
 {%- endif %}
 [{{ this_version }}]: {{ self::remote_url() }}/compare/{{ first_commit }}...{{ last_commit }}
 
@@ -148,10 +155,11 @@ commit_parsers = [
 # filter out the commits that are not matched by commit parsers
 filter_commits = true
 # sort the tags topologically
+# spell-checker: disable-next-line
 topo_order = false
 # sort the commits inside sections by oldest/newest order
 sort_commits = "oldest"
 
-# [remote.github]
-# owner = "cpp-linter"
-# repo = "cpp-linter-rs"
+[remote.github]
+owner = "cpp-linter"
+repo = "cpp-linter-rs"

.github/common.nu

@@ -36,6 +36,7 @@ export def --wrapped run-cmd [...cmd: string] {
         ($cmd | first)
     }
     print $"(ansi blue)\nRunning(ansi reset) ($cmd | str join ' ')"
+    # spell-checker: disable-next-line
     let elapsed = timeit {|| ^($cmd | first) ...($cmd | skip 1)}
     print $"(ansi magenta)($app) took ($elapsed)(ansi reset)"
 }

.github/workflows/bump-n-release.nu

@@ -5,6 +5,9 @@
 #
 #    This step requires `cargo-edit` installed.
 #
+#    If bumping the cpp-linter-js package, yarn must be installed to
+#    update the version in the bindings/node/package.json manifest also.
+#
 # 2. Updates the appropriate CHANGELOG.md
 #
 #    Requires `git-cliff` (see https://git-cliff.org) to be installed
@@ -85,6 +88,7 @@ const PkgPaths = {
         path: 'bindings/node'
     }
 }
+
 export def get-changed-pkgs [] {
     let changed_files = (
         git 'diff' '--name-only' 'HEAD~1' 'HEAD'
@@ -99,17 +103,15 @@ export def get-changed-pkgs [] {
         let pkg = $row.column0
         let paths = $row.column1
         print $"Checking changes for ($pkg)..."
-        let has_changed = if ($paths.include | is-empty) {
-            true
-        } else {
-            $changed_files | any {|file| $paths.include | each {|p| glob $p | any {|g| $g == $file}}}
+        let has_changed = if ($paths.include | is-empty) { true } else {
+            $changed_files | any {|file| $paths.include | any {|p| ($file | path expand) in (glob $p)}}
         }
         print $"  Has changes: ($has_changed)"
         let has_excluded_change = if ($paths.exclude | is-empty) { false } else {
-            $changed_files | any {|file| $paths.exclude | each {|p| glob $p | any {|g| $g == $file}}}
+            $changed_files | any {|file| $paths.exclude | any {|p| ($file | path expand) in (glob $p)}}
         }
         print $"  Has excluded changes: ($has_excluded_change)"
-        if $has_changed and not $has_excluded_change {
+        if $has_changed {
             print $" Package ($pkg) has relevant changes"
             $pkgs = $pkgs | append $pkg
         }
@@ -186,8 +188,6 @@ export def gen-changes [
     mut args = [
         '--config' $"($config_path | path join 'cliff.toml')"
         '--tag-pattern' $"($pkg)/*"
-        '--workdir' $path
-        '--repository' (pwd)
     ]
     if (($tag | str length) > 0) {
         $args = $args | append ['--tag', $tag]
@@ -255,13 +255,13 @@ def main [
     }
     if (is-in-ci) and $is_main {
         print 'Pushing metadata changes'
-        run-cmd 'git' 'config' '--global' 'user.name' $"($env.GITHUB_ACTOR)"
-        run-cmd 'git' 'config' '--global' 'user.email' $"($env.GITHUB_ACTOR_ID)+($env.GITHUB_ACTOR)@users.noreply.github.com"
-        run-cmd 'git' 'add' '--all'
-        run-cmd 'git' 'commit' '-m' $"build: bump version to ($tag)"
-        run-cmd 'git' 'push'
+        run-cmd git config --global user.name $"($env.GITHUB_ACTOR)"
+        run-cmd git config --global user.email $"($env.GITHUB_ACTOR_ID)+($env.GITHUB_ACTOR)@users.noreply.github.com"
+        run-cmd git add --all
+        run-cmd git commit -m $"build: bump version to ($tag)"
+        run-cmd git push
         print $"Deploying ($tag)"
-        run-cmd 'gh' 'release' 'create' $tag '--notes-file' '.config/ReleaseNotes.md' '--title' $"($pkg) v($ver)"
+        run-cmd gh release create $tag --notes-file .config/ReleaseNotes.md --title $"($pkg) v($ver)"
     } else if $is_main {
         print $"(ansi yellow)Not deploying from local clone.(ansi reset)"
     }

.github/workflows/bump-n-release.yml

@@ -62,6 +62,12 @@ jobs:
       - run: cargo binstall -y git-cliff
         env:
           GITHUB_TOKEN: ${{ github.token }}
+      - name: Install cargo-edit
+        run: >-
+          cargo install cargo-edit
+          --locked
+          --no-default-features
+          --features set-version
       - name: Install nushell
         uses: hustcer/setup-nu@92c296ba1ba2ba04cc948ab64ddefe192dc13f0c # v3.23
       - name: Bump ${{ inputs.component }} version

cspell.config.yml

@@ -29,6 +29,7 @@ words:
   - ecurity
   - efactor
   - elete
+  - elif
   - emove
   - endfor
   - endgroup
@@ -114,8 +115,6 @@ words:
   - tempdir
   - tempfile
   - thiserror
-  - timeit
-  - topo
   - twemoji
   - upport
   - vararg