ci: block rustfmt+cargo-deny; api: CSV include_header examples #27

zensgit · 2025-09-23T14:44:05Z

Make Clippy blocking in API job\n- Add Rustfmt Check and Cargo Deny as blocking jobs\n- jive-api/Makefile: add include_header examples for POST/GET CSV\n- AGENTS.md: document include_header flag\n\nIf approved, this enforces formatting and license advisories at PR time.

…; api: Makefile CSV export include_header examples; docs: AGENTS include_header notes

gemini-code-assist · 2025-09-23T14:44:18Z

Summary of Changes

Hello @zensgit, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces significant improvements to the project's development workflow and API documentation. It strengthens the continuous integration process by enforcing code style with Rustfmt, static analysis with Clippy, and dependency security with Cargo Deny as blocking checks. Additionally, it enhances the API's CSV export functionality by documenting the "include_header" option and providing practical Makefile examples for its usage.

Highlights

CI Pipeline: Made Clippy, Rustfmt, and Cargo Deny blocking jobs in the CI, ensuring code formatting and dependency security are enforced at PR time.
API Documentation: Documented the "include_header" flag for CSV export endpoints in AGENTS.md, explaining its usage for both POST and GET requests.
Developer Experience: Added new Makefile targets (export-csv, export-csv-stream) with curl examples to easily test and demonstrate the "include_header" functionality for CSV exports.
Local Testing: Modified the local-test command in the Makefile to run tests offline and capture output, improving the local development workflow.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

Copilot

Pull Request Overview

This PR enforces code quality standards by making formatting and security checks blocking in CI, while also adding CSV export documentation and examples. The changes implement stricter CI validation and improve developer documentation for CSV functionality.

Add blocking Rustfmt and Cargo Deny checks to CI pipeline
Make Clippy warnings blocking instead of optional
Add Makefile examples for CSV export with include_header parameter
Document CSV include_header functionality in AGENTS.md

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
.github/workflows/ci.yml	Adds rustfmt-check and cargo-deny jobs as blocking CI steps, makes clippy blocking
jive-api/Makefile	Adds convenience targets for CSV export with include_header examples
AGENTS.md	Documents CSV export include_header parameter usage

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-23T14:44:45Z

.github/workflows/ci.yml

+        components: rustfmt
+    - name: Check formatting (workspace)
+      run: |
+        rustup component add rustfmt || true


The || true makes this command always succeed, which could mask failures when rustfmt component installation fails. Since rustfmt is already specified in the toolchain components above, this line is redundant and should be removed.

Suggested change

rustup component add rustfmt || true

Copilot · 2025-09-23T14:44:45Z

.github/workflows/ci.yml

+    - uses: actions/checkout@v4
+    - name: Install cargo-deny
+      run: |
+        curl -sSfL https://github.com/EmbarkStudios/cargo-deny/releases/download/0.14.24/cargo-deny-0.14.24-x86_64-unknown-linux-musl.tar.gz | tar xz


Downloading and executing binaries from external URLs without verification poses a security risk. Consider using a GitHub Action like EmbarkStudios/cargo-deny-action or verify the binary checksum after download.

Suggested change

curl -sSfL https://github.com/EmbarkStudios/cargo-deny/releases/download/0.14.24/cargo-deny-0.14.24-x86_64-unknown-linux-musl.tar.gz | tar xz

set -e

VERSION=0.14.24

FILE="cargo-deny-${VERSION}-x86_64-unknown-linux-musl.tar.gz"

URL="https://github.com/EmbarkStudios/cargo-deny/releases/download/${VERSION}/${FILE}"

SHA256_URL="${URL}.sha256"

# Download tarball and checksum

curl -sSfL "$URL" -o "$FILE"

curl -sSfL "$SHA256_URL" -o "${FILE}.sha256"

# The .sha256 file contains the checksum and filename, but we need to match the filename

grep "$FILE" "${FILE}.sha256" > checksum.txt

sha256sum -c checksum.txt

# Extract and install

tar xzf "$FILE"

Copilot · 2025-09-23T14:44:46Z

jive-api/Makefile

 	@echo "Adminer: http://localhost:8080"
 	@echo "RedisInsight: http://localhost:8001"
+
+# 便捷：导出/审计（支持 include_header 传参）


[nitpick] The comment is in Chinese while the rest of the file uses English. For consistency and accessibility, consider translating to English: # Convenience: export/audit (supports include_header parameter)

Suggested change

# 便捷：导出/审计（支持 include_header 传参）

# Convenience: export/audit (supports include_header parameter)

gemini-code-assist

Code Review

This pull request introduces several improvements to the CI process by making Clippy, Rustfmt, and Cargo Deny checks blocking. It also adds helpful Makefile targets to demonstrate and test CSV export functionality, and documents the include_header parameter in AGENTS.md. The changes are mostly good, but I've found a small issue in one of the new Makefile targets that I've provided a suggestion for.

gemini-code-assist · 2025-09-23T14:45:58Z

jive-api/Makefile

+	curl -s -D - -H "Authorization: Bearer $${TOKEN}" \
+	  "http://localhost:$${API_PORT:-8012}/api/v1/transactions/export.csv?include_header=$${HEADER:-true}" \
+	  -o /tmp/transactions_export.csv | head -n 20


The pipe | head -n 20 in the export-csv-stream target is likely not behaving as intended. The curl command uses -o /tmp/transactions_export.csv to write the response body to a file, and -D - to write headers to standard output. As a result, head -n 20 will only process the response headers, not the CSV content.

To preview the first 20 lines of the downloaded CSV file, you should first let curl finish downloading and then run head on the output file. I've also removed the -D - flag which prints headers to standard output, as it would interfere with previewing the file content.

curl -s -H "Authorization: Bearer $${TOKEN}" \ "http://localhost:$${API_PORT:-8012}/api/v1/transactions/export.csv?include_header=$${HEADER:-true}" \ -o /tmp/transactions_export.csv && head -n 20 /tmp/transactions_export.csv

…o-deny and summary wiring

…rs to fix rustfmt

…mt blocking later

ci: make clippy blocking; add rustfmt and cargo-deny as blocking jobs…

7848a98

…; api: Makefile CSV export include_header examples; docs: AGENTS include_header notes

Copilot AI review requested due to automatic review settings September 23, 2025 14:44

Copilot AI reviewed Sep 23, 2025

View reviewed changes

gemini-code-assist bot reviewed Sep 23, 2025

View reviewed changes

zensgit added 7 commits September 23, 2025 22:51

ci: scope rustfmt to jive-api & jive-core; run cargo-deny in jive-api

45388ae

ci: resolve workflow merge markers; keep blocking clippy/rustfmt/carg…

7b5976c

…o-deny and summary wiring

ci: resolve workflow conflicts and align summary needs

e22cc4f

ci: make rustfmt and cargo-deny non-blocking to stabilize pipeline

7725806

style: run cargo fmt across API and core; add missing middleware mod.…

00200b0

…rs to fix rustfmt

ci: stabilize cargo-deny (minimal config) and plan to re-enable rustf…

9f5b47c

…mt blocking later

ci: make rustfmt blocking; upload cargo-deny output for diagnostics

5b60022

zensgit merged commit 4c021b8 into main Sep 24, 2025
19 of 27 checks passed

zensgit deleted the chore/ci-blocking-fmt-deny-and-export-examples branch September 24, 2025 01:35

zensgit mentioned this pull request Oct 15, 2025

core db track 1 #91

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

ci: block rustfmt+cargo-deny; api: CSV include_header examples #27

ci: block rustfmt+cargo-deny; api: CSV include_header examples #27

Uh oh!

zensgit commented Sep 23, 2025

Uh oh!

gemini-code-assist bot commented Sep 23, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 23, 2025

Uh oh!

Copilot AI Sep 23, 2025

Uh oh!

Copilot AI Sep 23, 2025

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Sep 23, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

-        curl -sSfL https://github.com/EmbarkStudios/cargo-deny/releases/download/0.14.24/cargo-deny-0.14.24-x86_64-unknown-linux-musl.tar.gz | tar xz
+        set -e
+        VERSION=0.14.24
+        FILE="cargo-deny-${VERSION}-x86_64-unknown-linux-musl.tar.gz"
+        URL="https://github.com/EmbarkStudios/cargo-deny/releases/download/${VERSION}/${FILE}"
+        SHA256_URL="${URL}.sha256"
+        # Download tarball and checksum
+        curl -sSfL "$URL" -o "$FILE"
+        curl -sSfL "$SHA256_URL" -o "${FILE}.sha256"
+        # The .sha256 file contains the checksum and filename, but we need to match the filename
+        grep "$FILE" "${FILE}.sha256" > checksum.txt
+        sha256sum -c checksum.txt
+        # Extract and install
+        tar xzf "$FILE"

	# 便捷：导出/审计（支持 include_header 传参）
	# Convenience: export/audit (supports include_header parameter)

ci: block rustfmt+cargo-deny; api: CSV include_header examples #27

ci: block rustfmt+cargo-deny; api: CSV include_header examples #27

Uh oh!

Conversation

zensgit commented Sep 23, 2025

Uh oh!

gemini-code-assist bot commented Sep 23, 2025

Summary of Changes

Highlights

Footnotes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant