Skip to content

Develop #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThiruNithish28 merged 8 commits into from
May 16, 2026
Merged

Develop #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1996a09
developed cli for auditgen (#1)
ThiruNithish28 Apr 26, 2026
0f6e51e
feat: improve CLI UX, prompts, and generate workflow
ThiruNithish28 May 3, 2026
e279f71
feat: add windows exe build pipeline and fix bundled template path (#3)
ThiruNithish28 May 3, 2026
f2d7735
Sync main into develop (#7)
ThiruNithish28 May 3, 2026
af76a2b
docs: add README, CHANGELOG and update yml file (#8)
ThiruNithish28 May 3, 2026
18ab475
fix: merge main hotfixes into develop
ThiruNithish28 May 4, 2026
df042a1
Fix/sync main to develop (#9)
ThiruNithish28 May 4, 2026
ed26fd0
Merge branch 'develop' of https://github.com/ThiruNithish28/audiGen-c…
ThiruNithish28 May 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ env:

on:
push:
branches: [main]
tags: ['v*']
workflow_dispatch:

jobs:
build:
runs-on: windows-latest
permissions:
contents: write

steps:
- name: Checkout code
Expand Down Expand Up @@ -53,4 +55,10 @@ jobs:
with:
name: auditgen-windows
path: dist/auditgen.exe
retention-days: 30
retention-days: 30

- name: Create Github Release
uses: softprops/action-gh-release@v2
with:
files: dist/auditgen.exe
generate_release_notes: true
Comment on lines +60 to +64
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add condition to prevent release step failure on manual triggers.

The release creation step will run on both tag pushes and manual workflow_dispatch triggers. When triggered manually without a tag context, this step will likely fail or produce unexpected results.

🔧 Proposed fix to conditionally run release only on tags 
       
       - name: Create Github Release
         uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
         with:
           files: dist/auditgen.exe
           generate_release_notes: true
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- name: Create Github Release
uses: softprops/action-gh-release@v2
with:
files: dist/auditgen.exe
generate_release_notes: true
- name: Create Github Release
uses: softprops/action-gh-release@v2
if: startsWith(github.ref, 'refs/tags/')
with:
files: dist/auditgen.exe
generate_release_notes: true
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.github/workflows/build.yml around lines 60 - 64, The "Create Github
Release" step (uses: softprops/action-gh-release@v2) runs on manual
workflow_dispatch and tag pushes causing failures when no tag exists; add a
conditional like if: startsWith(github.ref, 'refs/tags/') to the step to ensure
the release action (files: dist/auditgen.exe, generate_release_notes: true) only
executes for tag-created workflows.

4 changes: 4 additions & 0 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"python-envs.defaultEnvManager": "ms-python.python:poetry",
"python-envs.defaultPackageManager": "ms-python.python:poetry"
}
11 changes: 11 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Changelog

## [v0.1.0] - 2025-04-26
Comment thread
ThiruNithish28 marked this conversation as resolved.
### Added
- Interactive dual-mode CLI (flags or questionary prompts)
- Config registry with `auditgen config setup`
- Generates Impact Analysis, Test Cases, Code Checklist from BRD
- Windows EXE via GitHub Actions
- Input validation with friendly error messages
- Path traversal protection on ticket ID
- Ctrl+C handling across all prompts
Comment thread
ThiruNithish28 marked this conversation as resolved.
45 changes: 45 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# AudiGen CLI

Audit document generator CLI tool — generates Impact Analysis, Test Cases,
and Code Review Checklist from a BRD document using AI.

## Requirements
- Windows 10/11
- Gemini API key ([get one free here](https://aistudio.google.com/))

## Installation
1. Download `auditgen.exe` from [Releases](../../releases)
2. Place it in a folder e.g. `C:\Tools\auditgen\`
3. Add that folder to your Windows PATH
4. Open a new terminal and run `auditgen --help`

## First Time Setup
```cmd
auditgen config setup
```
Select all fields and enter your details when prompted.

## Usage
```cmd
# Interactive mode — prompts for everything
auditgen generate

# Direct mode — pass everything as flags
auditgen generate "path\to\brd.docx" TKT-001 -s 20-04-2025 -e 30-04-2025

# View your config
auditgen config show
```

## Output
Running `generate` produces three Excel files in your output folder:
- `TKT-001-Impact Analysis Template.xlsx`
- `TKT-001-Test Cases.xlsx`
- `TKT-001-Code Checklist.xlsx`

## Built With
- Python 3.12
- Click — CLI framework
- Google Gemini — test case generation
- openpyxl — Excel generation
- Rich + Questionary — terminal UI
Comment thread
ThiruNithish28 marked this conversation as resolved.
2 changes: 1 addition & 1 deletion audigen_cli/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,4 +270,4 @@ def generate(brd, ticket, start, end, user, complexity, priority, approver, outp
with open(log_path, "w") as f:
f.write(traceback.format_exc())
print(f"Crashed. Log saved to: {log_path}")
raise SystemExit(1)
raise SystemExit(1)