Skip to content

Commit 3a6395c

Browse files
itlackeyitlackey
committed
Update to giv-cli organization URL
[refactor] Updated GitHub repository URLs from itlackey/giv to giv-cli/giv in install commands and references throughout the codebase. [style] Refactored debug output formatting in `parse_args` function for better readability.
1 parent 05c2f1b commit 3a6395c

File tree

8 files changed

+124
-79
lines changed

8 files changed

+124
-79
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,4 +233,4 @@ Generated my giv
233233

234234
- Fixed an issue where the script does not append to the end of changelog if no existing sections are found.
235235

236-
[Managed by giv](https://github.com/itlackey/giv)
236+
[Managed by giv](https://github.com/giv-cli/giv)

‎README.md‎

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@
2929
# Commit message for working tree
3030
giv message
3131

32+
# Commit staged changes with a generated commit message
33+
git commit -m "$(giv message --cached)"
34+
3235
# Create/update a changelog, scanning TODOs in *.ts files only
3336
giv changelog --todo-files '*.ts' --todo-pattern 'TODO\\(\\w+\\):'
3437

@@ -44,7 +47,7 @@ giv release-notes v1.2.0..HEAD \
4447
## Installation
4548

4649
```bash
47-
curl -fsSL https://raw.githubusercontent.com/itlackey/giv/main/install.sh | sh
50+
curl -fsSL https://raw.githubusercontent.com/giv-cli/giv/main/install.sh | sh
4851
```
4952

5053
The script downloads the latest binary links it in `$PATH`
@@ -155,6 +158,50 @@ giv <subcommand> [revision] [pathspec] [OPTIONS]
155158

156159
CC-BY. If **giv** helps you *give* better releases, please ⭐ the repo and spread the word!
157160

161+
## Contributing
162+
163+
I'll help you fill in the "Contributing" section with the requested information. Here's a suggestion:
164+
165+
---
166+
167+
## Contributing
168+
169+
We welcome contributions from everyone! If you'd like to contribute, please follow these steps:
170+
171+
1. **Clone the repository and update submodules:**
172+
```bash
173+
git clone https://github.com/giv-cli/giv.git
174+
cd giv
175+
git submodule update --init --recursive
176+
```
177+
178+
2. **Create a new branch for your changes:**
179+
```bash
180+
git checkout -b my-feature-branch
181+
```
182+
183+
3. **Make your changes and commit them:**
184+
```bash
185+
# Make changes...
186+
187+
# Verify all tests pass
188+
bats tests/*.bats
189+
190+
git add .
191+
git commit -m "$(giv message --staged)"
192+
```
193+
194+
4. **Push your changes to GitHub:**
195+
```bash
196+
git push origin my-feature-branch
197+
```
198+
199+
5. **Create a pull request on GitHub.**
200+
201+
Please ensure that your contributions adhere to the existing code style and include appropriate tests if necessary.
202+
203+
204+
158205
[1]: https://keepachangelog.com/en/1.1.0/ "Keep a Changelog"
159206
[2]: https://semver.org/ "Semantic Versioning 2.0.0 | Semantic Versioning"
160207
[3]: https://git-scm.com/downloads "Git Downloads"

‎docs/installation.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,31 @@
1414
Run this in your terminal to install the latest released version of `giv`:
1515

1616
```bash
17-
curl -fsSL https://raw.githubusercontent.com/itlackey/giv/main/install.sh | sh
17+
curl -fsSL https://raw.githubusercontent.com/giv-cli/giv/main/install.sh | sh
1818
```
1919

2020
## Install a Specific Version
2121

2222
To install a specific version (e.g., `v0.1.9`):
2323

2424
```bash
25-
curl -fsSL https://raw.githubusercontent.com/itlackey/giv/main/install.sh | sh -s -- --version v0.1.9
25+
curl -fsSL https://raw.githubusercontent.com/giv-cli/giv/main/install.sh | sh -s -- --version v0.1.9
2626
```
2727

2828
## Install the Latest Changes from the `main` Branch
2929

3030
To install the very latest changes (may be unstable):
3131

3232
```bash
33-
curl -fsSL https://raw.githubusercontent.com/itlackey/giv/main/install.sh | sh -s -- --version main
33+
curl -fsSL https://raw.githubusercontent.com/giv-cli/giv/main/install.sh | sh -s -- --version main
3434
```
3535

3636
## Install the Latest Changes from a specific Branch
3737

3838
To install from a different branch (may be unstable):
3939

4040
```bash
41-
curl -fsSL https://raw.githubusercontent.com/itlackey/giv/main/install.sh | sh -s -- --version <branch name>
41+
curl -fsSL https://raw.githubusercontent.com/giv-cli/giv/main/install.sh | sh -s -- --version <branch name>
4242
```
4343

4444
## How the Installer Works

‎docs/using_changeish_with_npm.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Supercharge Your npm Project Changelog with AI: Automate Releases Using giv
22

3-
Keeping a changelog up to date is essential for any project, but it’s often tedious and easy to neglect. What if you could automate beautiful, structured changelogs using AI—right from your npm workflow? Enter [giv](https://github.com/itlackey/giv): an open-source Bash tool that summarizes your Git history into clean, Markdown changelogs using local or remote AI models.
3+
Keeping a changelog up to date is essential for any project, but it’s often tedious and easy to neglect. What if you could automate beautiful, structured changelogs using AI—right from your npm workflow? Enter [giv](https://github.com/giv-cli/giv): an open-source Bash tool that summarizes your Git history into clean, Markdown changelogs using local or remote AI models.
44

55
In this post, I’ll show you how to integrate giv into your npm-based project, customize it for your workflow, and never stress about changelogs again.
66

@@ -20,7 +20,7 @@ In this post, I’ll show you how to integrate giv into your npm-based project,
2020
First, install giv globally:
2121

2222
```bash
23-
curl -fsSL https://raw.githubusercontent.com/itlackey/giv/main/install.sh | sh
23+
curl -fsSL https://raw.githubusercontent.com/giv-cli/giv/main/install.sh | sh
2424
```
2525

2626
---
@@ -124,7 +124,7 @@ Or for staged changes:
124124

125125
Automate your changelog, impress your users, and streamline your releases. Add giv to your npm project today and let AI do the heavy lifting.
126126

127-
👉 [Get giv on GitHub](https://github.com/itlackey/giv)
127+
👉 [Get giv on GitHub](https://github.com/giv-cli/giv)
128128

129129
---
130130

‎install.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
set -eu
44

55
# Repository and filenames
6-
REPO="itlackey/giv"
6+
REPO="giv-cli/giv"
77
SCRIPT_NAME="giv.sh"
88
USER_BIN_DIR=""
99
APP_DIR=""

‎src/giv.sh‎

Lines changed: 30 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -337,35 +337,33 @@ parse_args() {
337337

338338
[ "${model_mode}" = "none" ] && print_warn "Model mode set to \"none\", no model will be used."
339339

340-
if [ "$debug" = "true" ]; then
341-
printf 'Environment variables:\n'
342-
printf ' GIV_TMPDIR: %s\n' "${GIV_TMPDIR:-}"
343-
printf ' GIV_MODEL_MODE: %s\n' "${GIV_MODEL_MODE:-}"
344-
printf ' GIV_MODEL: %s\n' "${GIV_MODEL:-}"
345-
printf ' GIV_API_MODEL: %s\n' "${GIV_API_MODEL:-}"
346-
printf ' GIV_API_URL: %s\n' "${GIV_API_URL:-}"
347-
echo "Parsed options:"
348-
echo " Debug: $debug"
349-
echo " Dry Run: $dry_run"
350-
echo " Subcommand: $subcmd"
351-
echo " Revision: $REVISION"
352-
echo " Pathspec: $PATHSPEC"
353-
echo " Template Directory: $template_dir"
354-
echo " Config File: $config_file"
355-
echo " Config Loaded: $is_config_loaded"
356-
echo " Output File: $output_file"
357-
echo " TODO Files: $todo_files"
358-
echo " TODO Pattern: $todo_pattern"
359-
echo " Version File: $version_file"
360-
echo " Version Pattern: $version_pattern"
361-
echo " Model: $model"
362-
echo " Model Mode: $model_mode"
363-
echo " API Model: $api_model"
364-
echo " API URL: $api_url"
365-
echo " Output Mode: $output_mode"
366-
echo " Output Version: $output_version"
367-
echo " Prompt File: $prompt_file"
368-
fi
340+
print_debug "Environment variables:"
341+
print_debug " GIV_TMPDIR: ${GIV_TMPDIR:-}"
342+
print_debug " GIV_MODEL_MODE: ${GIV_MODEL_MODE:-}"
343+
print_debug " GIV_MODEL: ${GIV_MODEL:-}"
344+
print_debug " GIV_API_MODEL: ${GIV_API_MODEL:-}"
345+
print_debug " GIV_API_URL: ${GIV_API_URL:-}"
346+
print_debug "Parsed options:"
347+
print_debug " Debug: $debug"
348+
print_debug " Dry Run: $dry_run"
349+
print_debug " Subcommand: $subcmd"
350+
print_debug " Revision: $REVISION"
351+
print_debug " Pathspec: $PATHSPEC"
352+
print_debug " Template Directory: $template_dir"
353+
print_debug " Config File: $config_file"
354+
print_debug " Config Loaded: $is_config_loaded"
355+
print_debug " Output File: $output_file"
356+
print_debug " TODO Files: $todo_files"
357+
print_debug " TODO Pattern: $todo_pattern"
358+
print_debug " Version File: $version_file"
359+
print_debug " Version Pattern: $version_pattern"
360+
print_debug " Model: $model"
361+
print_debug " Model Mode: $model_mode"
362+
print_debug " API Model: $api_model"
363+
print_debug " API URL: $api_url"
364+
print_debug " Output Mode: $output_mode"
365+
print_debug " Output Version: $output_version"
366+
print_debug " Prompt File: $prompt_file"
369367
}
370368
# -------------------------------------------------------------------
371369
# Helper Functions
@@ -375,7 +373,7 @@ show_version() {
375373
}
376374
# Show all available release tags
377375
get_available_releases() {
378-
curl -s https://api.github.com/repos/itlackey/giv/releases | awk -F'"' '/"tag_name":/ {print $4}'
376+
curl -s https://api.github.com/repos/giv-cli/giv/releases | awk -F'"' '/"tag_name":/ {print $4}'
379377
exit 0
380378
}
381379
# Update the script to a specific release version (or latest if not specified)
@@ -384,10 +382,10 @@ run_update() {
384382
if [ "$version" = "latest" ]; then
385383
latest_version=$(get_available_releases | head -n 1)
386384
printf 'Updating giv to version %s...\n' "${latest_version}"
387-
curl -fsSL https://raw.githubusercontent.com/itlackey/giv/main/install.sh | sh -- --version "${latest_version}"
385+
curl -fsSL https://raw.githubusercontent.com/giv-cli/giv/main/install.sh | sh -- --version "${latest_version}"
388386
else
389387
printf 'Updating giv to version %s...\n' "${version}"
390-
curl -fsSL "https://raw.githubusercontent.com/itlackey/giv/main/install.sh" | sh -- --version "${version}"
388+
curl -fsSL "https://raw.githubusercontent.com/giv-cli/giv/main/install.sh" | sh -- --version "${version}"
391389
fi
392390
printf 'Update complete.\n'
393391
exit 0

‎tests/assets/changelog.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,4 +81,4 @@
8181

8282
- Fixed an issue where the script does not append to the end of changelog if no existing sections are found.
8383

84-
[Managed by giv](https://github.com/itlackey/giv)
84+
[Managed by giv](https://github.com/giv-cli/giv)

‎tests/tests.bats‎

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -251,28 +251,28 @@ gen_commits() {
251251
#!/bin/bash
252252
echo '[
253253
{
254-
"url": "https://api.github.com/repos/itlackey/giv/releases/228995989",
255-
"assets_url": "https://api.github.com/repos/itlackey/giv/releases/228995989/assets",
256-
"upload_url": "https://uploads.github.com/repos/itlackey/giv/releases/228995989/assets{?name,label}",
257-
"html_url": "https://github.com/itlackey/giv/releases/tag/0.2.0",
254+
"url": "https://api.github.com/repos/giv-cli/giv/releases/228995989",
255+
"assets_url": "https://api.github.com/repos/giv-cli/giv/releases/228995989/assets",
256+
"upload_url": "https://uploads.github.com/repos/giv-cli/giv/releases/228995989/assets{?name,label}",
257+
"html_url": "https://github.com/giv-cli/giv/releases/tag/0.2.0",
258258
"id": 228995989,
259259
"author": {
260-
"login": "itlackey",
260+
"login": "giv-cli",
261261
"id": 6414031,
262262
"node_id": "MDQ6VXNlcjY0MTQwMzE=",
263263
"avatar_url": "https://avatars.githubusercontent.com/u/6414031?v=4",
264264
"gravatar_id": "",
265-
"url": "https://api.github.com/users/itlackey",
266-
"html_url": "https://github.com/itlackey",
267-
"followers_url": "https://api.github.com/users/itlackey/followers",
268-
"following_url": "https://api.github.com/users/itlackey/following{/other_user}",
269-
"gists_url": "https://api.github.com/users/itlackey/gists{/gist_id}",
270-
"starred_url": "https://api.github.com/users/itlackey/starred{/owner}{/repo}",
271-
"subscriptions_url": "https://api.github.com/users/itlackey/subscriptions",
272-
"organizations_url": "https://api.github.com/users/itlackey/orgs",
273-
"repos_url": "https://api.github.com/users/itlackey/repos",
274-
"events_url": "https://api.github.com/users/itlackey/events{/privacy}",
275-
"received_events_url": "https://api.github.com/users/itlackey/received_events",
265+
"url": "https://api.github.com/users/giv-cli",
266+
"html_url": "https://github.com/giv-cli",
267+
"followers_url": "https://api.github.com/users/giv-cli/followers",
268+
"following_url": "https://api.github.com/users/giv-cli/following{/other_user}",
269+
"gists_url": "https://api.github.com/users/giv-cli/gists{/gist_id}",
270+
"starred_url": "https://api.github.com/users/giv-cli/starred{/owner}{/repo}",
271+
"subscriptions_url": "https://api.github.com/users/giv-cli/subscriptions",
272+
"organizations_url": "https://api.github.com/users/giv-cli/orgs",
273+
"repos_url": "https://api.github.com/users/giv-cli/repos",
274+
"events_url": "https://api.github.com/users/giv-cli/events{/privacy}",
275+
"received_events_url": "https://api.github.com/users/giv-cli/received_events",
276276
"type": "User",
277277
"user_view_type": "public",
278278
"site_admin": false
@@ -286,33 +286,33 @@ echo '[
286286
"created_at": "2025-07-01T02:39:16Z",
287287
"published_at": "2025-07-01T05:59:26Z",
288288
"assets": [],
289-
"tarball_url": "https://api.github.com/repos/itlackey/giv/tarball/0.2.0",
290-
"zipball_url": "https://api.github.com/repos/itlackey/giv/zipball/0.2.0",
289+
"tarball_url": "https://api.github.com/repos/giv-cli/giv/tarball/0.2.0",
290+
"zipball_url": "https://api.github.com/repos/giv-cli/giv/zipball/0.2.0",
291291
"body": "## What'\''s New in v0.2.0"
292292
},
293293
{
294-
"url": "https://api.github.com/repos/itlackey/giv/releases/226567952",
295-
"assets_url": "https://api.github.com/repos/itlackey/giv/releases/226567952/assets",
296-
"upload_url": "https://uploads.github.com/repos/itlackey/giv/releases/226567952/assets{?name,label}",
297-
"html_url": "https://github.com/itlackey/giv/releases/tag/v0.1.10",
294+
"url": "https://api.github.com/repos/giv-cli/giv/releases/226567952",
295+
"assets_url": "https://api.github.com/repos/giv-cli/giv/releases/226567952/assets",
296+
"upload_url": "https://uploads.github.com/repos/giv-cli/giv/releases/226567952/assets{?name,label}",
297+
"html_url": "https://github.com/giv-cli/giv/releases/tag/v0.1.10",
298298
"id": 226567952,
299299
"author": {
300-
"login": "itlackey",
300+
"login": "giv-cli",
301301
"id": 6414031,
302302
"node_id": "MDQ6VXNlcjY0MTQwMzE=",
303303
"avatar_url": "https://avatars.githubusercontent.com/u/6414031?v=4",
304304
"gravatar_id": "",
305-
"url": "https://api.github.com/users/itlackey",
306-
"html_url": "https://github.com/itlackey",
307-
"followers_url": "https://api.github.com/users/itlackey/followers",
308-
"following_url": "https://api.github.com/users/itlackey/following{/other_user}",
309-
"gists_url": "https://api.github.com/users/itlackey/gists{/gist_id}",
310-
"starred_url": "https://api.github.com/users/itlackey/starred{/owner}{/repo}",
311-
"subscriptions_url": "https://api.github.com/users/itlackey/subscriptions",
312-
"organizations_url": "https://api.github.com/users/itlackey/orgs",
313-
"repos_url": "https://api.github.com/users/itlackey/repos",
314-
"events_url": "https://api.github.com/users/itlackey/events{/privacy}",
315-
"received_events_url": "https://api.github.com/users/itlackey/received_events",
305+
"url": "https://api.github.com/users/giv-cli",
306+
"html_url": "https://github.com/giv-cli",
307+
"followers_url": "https://api.github.com/users/giv-cli/followers",
308+
"following_url": "https://api.github.com/users/giv-cli/following{/other_user}",
309+
"gists_url": "https://api.github.com/users/giv-cli/gists{/gist_id}",
310+
"starred_url": "https://api.github.com/users/giv-cli/starred{/owner}{/repo}",
311+
"subscriptions_url": "https://api.github.com/users/giv-cli/subscriptions",
312+
"organizations_url": "https://api.github.com/users/giv-cli/orgs",
313+
"repos_url": "https://api.github.com/users/giv-cli/repos",
314+
"events_url": "https://api.github.com/users/giv-cli/events{/privacy}",
315+
"received_events_url": "https://api.github.com/users/giv-cli/received_events",
316316
"type": "User",
317317
"user_view_type": "public",
318318
"site_admin": false
@@ -326,8 +326,8 @@ echo '[
326326
"created_at": "2025-06-20T03:05:11Z",
327327
"published_at": "2025-06-20T03:07:47Z",
328328
"assets": [],
329-
"tarball_url": "https://api.github.com/repos/itlackey/giv/tarball/v0.1.10",
330-
"zipball_url": "https://api.github.com/repos/itlackey/giv/zipball/v0.1.10",
329+
"tarball_url": "https://api.github.com/repos/giv-cli/giv/tarball/v0.1.10",
330+
"zipball_url": "https://api.github.com/repos/giv-cli/giv/zipball/v0.1.10",
331331
"body": "## What'\''s Changed"
332332
}
333333
]'

0 commit comments

Comments
 (0)