fix: release CI

.github/workflows/ci.yml

@@ -27,23 +27,22 @@ jobs:
       - name: Failed
         run: exit 1
         if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') || contains(needs.*.result, 'skipped')
-
   lint:
     runs-on: ubuntu-latest
     steps:
       - name: checkout
-        uses: actions/checkout@v4      
+        uses: actions/checkout@v4
       - name: install rust
         uses: dtolnay/rust-toolchain@stable
         with:
           toolchain: stable
           components: rustfmt, clippy
       - name: install protoc
         uses: arduino/setup-protoc@v3
-      - run: |            
-            git config --global --add url."https://${{ secrets.GH_TOKEN }}:x-oauth-basic@github.com/".insteadOf "git@github.com:"
-            git config --global --add url."https://${{ secrets.GH_TOKEN }}:x-oauth-basic@github".insteadOf https://github
-            git config --global --add url."https://${{ secrets.GH_TOKEN }}:x-oauth-basic@github".insteadOf ssh://git@github
+      - run: |
+          git config --global --add url."https://${{ secrets.GH_TOKEN }}:x-oauth-basic@github.com/".insteadOf "git@github.com:"
+          git config --global --add url."https://${{ secrets.GH_TOKEN }}:x-oauth-basic@github".insteadOf https://github
+          git config --global --add url."https://${{ secrets.GH_TOKEN }}:x-oauth-basic@github".insteadOf ssh://git@github
       - uses: Swatinem/rust-cache@v2
       - name: Install cargo-sort
         uses: baptiste0928/cargo-install@v3
@@ -53,7 +52,7 @@ jobs:
       - name: Check documentation
         env:
           RUSTDOCFLAGS: -D warnings
-        run: cargo doc --workspace --all-features --no-deps --document-private-items            
+        run: cargo doc --workspace --all-features --no-deps --document-private-items
       - name: Check formatting
         run: cargo fmt --all -- --check
       - name: Check Cargo.toml sorting

.github/workflows/release.yml

@@ -1,7 +1,7 @@
 name: release
 on:
   push:
-    tags: ["[0-9]+.[0-9]+.[0-9]+*"]  
+    tags: ["[0-9]+.[0-9]+.[0-9]+*"]
   workflow_dispatch:
 jobs:
   build_binaries:

CHANGELOG.md

@@ -1,3 +1,30 @@
-## 0.1.0
+# Changelog
 
-- All s2 operations.
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### Features
+
+- Implement `AccountService` ([#1](https://github.com/s2-streamstore/s2-cli/issues/1))
+- Implement `BasinService` ([#2](https://github.com/s2-streamstore/s2-cli/issues/2))
+- Implement `StreamService` ([#3](https://github.com/s2-streamstore/s2-cli/issues/3))
+
+### Bug Fixes
+
+- Try to fix release CI ([#9](https://github.com/s2-streamstore/s2-cli/issues/9))
+- Release CI ([#10](https://github.com/s2-streamstore/s2-cli/issues/10))
+- Release CI ([#11](https://github.com/s2-streamstore/s2-cli/issues/11))
+- Automatically add release notes ([#12](https://github.com/s2-streamstore/s2-cli/issues/12))
+- Changelog ([#13](https://github.com/s2-streamstore/s2-cli/issues/13))
+
+### Miscellaneous Tasks
+
+- Reflect renamed repo
+- Upgrade deps
+- Clippy, whitespace
+- Add CI action ([#6](https://github.com/s2-streamstore/s2-cli/issues/6))
+- CODEOWNERS ([#7](https://github.com/s2-streamstore/s2-cli/issues/7))
+- Add release CI action ([#8](https://github.com/s2-streamstore/s2-cli/issues/8))
+
+<!-- generated by git-cliff -->

cliff.toml

@@ -0,0 +1,83 @@
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+#
+# Lines starting with "#" are comments.
+# Configuration options are organized into tables and keys.
+# See documentation for more information on available options.
+
+[changelog]
+# template for the changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+            {% if commit.breaking %}[**breaking**] {% endif %}\
+            {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# remove the leading and trailing s
+trim = true
+# postprocessors
+postprocessors = [
+  { pattern = '<REPO>', replace = "https://github.com/s2-streamstore/s2-cli" }, # replace repository URL
+]
+# render body even when there are no releases to process
+# render_always = true
+# output file path
+# output = "test.md"
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  # Replace issue numbers
+  { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
+  # Check spelling of the commit with https://github.com/crate-ci/typos
+  # If the spelling is incorrect, it will be automatically fixed.
+  #{ pattern = '.*', replace_command = 'typos --write-changes -' },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 --> Features" },
+  { message = "^fix", group = "<!-- 1 --> Bug Fixes" },
+  { message = "^doc", group = "<!-- 3 --> Documentation" },
+  { message = "^perf", group = "<!-- 4 --> Performance" },
+  { message = "^refactor", group = "<!-- 2 --> Refactor" },
+  { message = "^style", group = "<!-- 5 --> Styling" },
+  { message = "^test", group = "<!-- 6 --> Testing" },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore\\(deps.*\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^chore|^ci", group = "<!-- 7 --> Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 8 --> Security" },
+  { message = "^revert", group = "<!-- 9 --> Revert" },
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"