cog-bump(1)

πŸ“¦ version 7.0.0, in arch rolling

πŸŽ€ COG-BUMP(1) πŸŽ€

okay so bestie, welcome to cog-bump β€” it's a General Commands Manual situation, and I'm gonna walk you through it like we're on FaceTime at 1am πŸ’–


✨ NAME ✨

cog-bump β€” commit changelog from latest tag to HEAD and create new tag

like, literally that's the whole vibe: it writes your changelog from the latest tag up to HEAD, then slaps a new tag on it. icon behavior fr 🫢


🌸 SYNOPSIS 🌸

cog-bump [--version] [-a|--auto] [-M|--major] [-m|--minor] [-p|--patch]
[--pre] [--build] [-H|--hook-profile] [--package] [-A|--annotated]
[-d|--dry-run] [--skip-ci] [--skip-ci-override] [--skip-untracked]
[--disable-bump-commit] [--include-packages] [-h|--help]

copy it exactly bestie, don't be creative with the flags πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

Commit changelog from latest tag to HEAD and create new tag.

that's it. that's the whole personality. it takes everything between your latest tag and HEAD, turns it into a changelog commit, and then makes you a shiny new tag. no cap, it's giving "release day but make it automated" ✨


πŸ’œ OPTIONS πŸ’œ

  • --version <VERSION> β€” you set the target version yourself, manually, with your own two hands. main character energy πŸ‘‘
  • -a, --auto β€” let it auto-suggest the target version for you. it's got you, babe 🫢
  • -M, --major β€” increment the major version. big moves only πŸ”₯
  • -m, --minor β€” increment the minor version. cute, modest, effective 🌸
  • -p, --patch β€” increment the patch version. tiny little fix, still iconic πŸŽ€
  • --pre [<PRE>] β€” set the pre-release version (e.g. "beta.1")

or increment it based on a pattern (e.g. "beta.*") β€” yes bestie, the wildcard is real ⭐

if you don't give it a value at all, it falls back to the pre defined in cog.toml. no drama, it just checks the config πŸ™ˆ

  • --build <BUILD> β€” set the build suffix. garnish for your version string πŸ“
  • -H, --hook-profile <HOOK_PROFILE> β€” specify the bump profile hooks to run. like picking which playlist plays during your release πŸ’…
  • --package <PACKAGE> β€” specify which package to bump for monorepo. one package gets the spotlight πŸ‘‘
  • -A, --annotated <ANNOTATED> β€” annotate the tag with the message you give it πŸ“
  • -d, --dry-run β€” dry-run: print the target version. no action taken. literally nothing happens, it's just a vibe check πŸ‘€
  • --skip-ci β€” add the skip-ci string defined in the cog.toml (or defaults to [skip ci]) to the bump commit. tells CI to sit this one out πŸ’€
  • --skip-ci-override <SKIP_CI_OVERRIDE> β€” override and add the skip-ci string with the value you provide to the bump commit. you're the boss of the string now πŸ”₯
  • --skip-untracked β€” don't fail if there are untracked or uncommitted files. let it slide πŸ™ˆ
  • --disable-bump-commit β€” disable the creation of the bump commit. no commit, just tag energy ⭐
  • --include-packages β€” also bump packages on manual bump

this overrides the default behaviour for --patch, --minor, --major and --version to only bump the global version for monorepos. useful to bump to version 1.0.0 πŸš€

  • -h, --help β€” print help (see a summary with '-h'). the classic 🫢
ngl bestie, peep that -h note: -h gives you the short summary, --help gives you the whole essay. iykyk πŸ’…

and that's the tea β˜• β€” this page, cog-bump(1), is from the cog-bump manual (General Commands Manual), version cog-bump, dated cog-bump(1). mwah, go tag something beautiful πŸŽ€πŸ’–βœ¨

πŸ“¦ where this page comes from