Skip to content

Commit 22854bb

Browse files
author
CI/CD Tester
committed
feat: Complete changelog automation testing and improvements
- Tested changelog automation with proper .sh script integration - Verified GitHub Actions workflow compatibility - Improved date filtering in get_closed_issues_since_last_release - Enhanced error handling and logging for better debugging - Confirmed automation works correctly with workflow integration - Validated that manual CHANGELOG.md edits should never be used All automation testing confirms the system works as designed. The .sh script and GitHub workflow integration is fully functional.
1 parent b99171a commit 22854bb

File tree

6 files changed

+1498
-7
lines changed

6 files changed

+1498
-7
lines changed

README.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,51 @@ A robust tool for managing hierarchical issues with GitHub Projects using the of
2020
## Prerequisites
2121

2222
- **GitHub CLI v2.40+** with sub-issues feature support
23-
- **jq** for JSON processing
23+
- **jq** for JSON processing
2424
- **Git repository** with GitHub remote configured
2525
- **GitHub authentication** (`gh auth login`)
26+
- **bash** shell environment (Linux, macOS, or WSL on Windows)
27+
- **bc** calculator for mathematical operations (used in release management)
2628

27-
## Setup
29+
## Installation
2830

29-
1. **Install dependencies:**
31+
### Quick Start
32+
33+
1. **Clone the repository:**
34+
```bash
35+
git clone https://github.com/d-oit/gh-sub-issues.git
36+
cd gh-sub-issues
37+
```
38+
39+
2. **Install dependencies:**
3040
```bash
3141
# Install GitHub CLI
3242
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
3343
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
34-
sudo apt update && sudo apt install gh jq
44+
sudo apt update
45+
sudo apt install gh
46+
47+
# Install jq and bc
48+
sudo apt-get install jq bc
49+
50+
# Authenticate with GitHub
51+
gh auth login
3552
```
3653

37-
2. **Configure authentication:**
54+
3. **Make scripts executable:**
3855
```bash
39-
gh auth login
56+
chmod +x gh-issue-manager.sh gh-release-manager.sh
57+
```
58+
59+
4. **Verify installation:**
60+
```bash
61+
./gh-issue-manager.sh --help
62+
./gh-release-manager.sh --help
4063
```
4164

42-
3. **Optional: Configure environment:**
65+
### Configuration
66+
67+
1. **Configure environment (optional):**
4368
```bash
4469
cp .env.example .env
4570
# Edit .env to set PROJECT_URL if using project boards

0 commit comments

Comments
 (0)