Skip to content

fix(koji): update binary path, docs #968

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
coolaj86 merged 3 commits into from
Feb 20, 2025
Merged

fix(koji): update binary path, docs #968

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed8058d
fix(koji): update binary path
cococonscious Feb 19, 2025
e6b3aec
docs(koji): fix mistakes, improve
cococonscious Feb 19, 2025
3d1a751
ref(koji): keep backwards-compat
coolaj86 Feb 20, 2025
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
20 changes: 11 additions & 9 deletions koji/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ You can use koji in one of two ways:
Here's the shortlist of options we've found most useful:

```text
-e, --emoji - use emoji for commit type (ex: `✨ feat:`)
-e, --emoji - use emoji for commit summary (ex: `feat: ✨ ...`)
-a, --autocomplete - guess 'scope' based on commit history (slow on large projects)
--hook - expect to be run from 'git commit', rather than wrap it
```
Expand Down Expand Up @@ -72,8 +72,8 @@ git commit

### How to use Emoji

You can use `-e` (or `--emoji`) to prepend your commit message with the relevant
emoji for the commit type:
You can use `-e` (or `--emoji`) to prepend your commit message summary with the
relevant emoji for the commit type:

```sh
koji -e
Expand All @@ -91,18 +91,20 @@ koji --emoji --hook
You can also use _shortcodes_ (`:pinched_fingers:`) in the scope, summary, or
body.

### How to configure Koji (custom emoji)
### How to configure koji

You can add custom commit types via a `koji.toml` in the project directory.
You can configure koji via a custom config passed with `--config`, a
`.koji.toml` file in the project root, or a user config at
`~/.config/koji/config.toml`.

For example:
Here's an example of a custom commit type:

```toml
[[commit_types]]
name = "feat"
name = "cust"
emoji = "✨"
description = "A new feature"
description = "A custom commit type"
```

The default emoji can be seen in
The default configuration can be seen in
[default.toml](https://github.com/cococonscious/koji/blob/main/meta/config/default.toml).
19 changes: 15 additions & 4 deletions koji/install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,28 @@ __init_koji() {
# ~/.local/opt/koji-v1.5.0/bin
mkdir -p "$(dirname "$pkg_src_cmd")"

# mv ./koji-*/koji ~/.local/opt/koji-v1.5.0/bin/koji
mv ./koji-*/koji "$pkg_src_cmd"
if test -f ./koji; then
# mv koji ~/.local/opt/koji-v1.5.0/bin/koji
mv ./koji "$pkg_src_cmd"
elif test -e ./koji-*/koji; then
# mv koji-1.4.0/koji ~/.local/opt/koji-v1.4.0/bin/koji
mv ./koji-*/koji "$pkg_src_cmd"
elif test -e ./koji-*; then
# mv koji-linux-amd64 ~/.local/opt/koji-v1.2.0/bin/koji
mv ./koji-* "$pkg_src_cmd"
else
echo >&2 "failed to find 'koji' exectutable"
return 1
fi
}

# pkg_get_current_version is recommended, but (soon) not required
pkg_get_current_version() {
# 'koji version' has output in this format:
# 'koji --version' has output in this format:
# koji 1.5.0
# This trims it down to just the version number:
# 1.5.0
koji --version 2> /dev/null | cut -c6-
koji --version 2> /dev/null | head -n 1 | cut -d' ' -f2
}
}

Expand Down