Skip to content

docs: cross-link in lib/git.mjs #21

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
kory-kaai merged 1 commit into from
Aug 21, 2026
Merged

docs: cross-link in lib/git.mjs #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
69 changes: 2 additions & 67 deletions lib/git.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,67 +1,2 @@
import { run } from "./exec.mjs";

/**
* @param {string} [cwd]
*/
export async function getLatestTag(cwd) {
const result = await run("git", ["describe", "--tags", "--abbrev=0"], {
cwd,
allowFail: true,
});
if (!result.ok) {
return null;
}
return result.stdout || null;
}

/**
* @param {string} [cwd]
*/
export async function isWorkingTreeClean(cwd) {
const result = await run("git", ["status", "--porcelain"], { cwd });
return result.stdout.length === 0;
}

/**
* @param {string} [cwd]
*/
export async function getCurrentBranch(cwd) {
const result = await run("git", ["branch", "--show-current"], { cwd });
return result.stdout;
}

/**
* @param {string} fromRef
* @param {string} [cwd]
*/
export async function getCommitsSince(fromRef, cwd) {
const range = fromRef ? `${fromRef}..HEAD` : "HEAD";
const result = await run(
"git",
["log", range, "--pretty=format:%s|||%h|||%an"],
{ cwd },
);
if (!result.stdout) {
return [];
}
return result.stdout.split("\n").map((line) => {
const [subject, hash, author] = line.split("|||");
return { subject, hash, author };
});
}

/**
* @param {string} tag
* @param {string} message
* @param {string} [cwd]
*/
export async function createTag(tag, message, cwd) {
await run("git", ["tag", "-a", tag, "-m", message], { cwd });
}

/**
* @param {string} [cwd]
*/
export async function pushTags(cwd) {
await run("git", ["push", "--follow-tags"], { cwd });
}
// @korykaai/collab-kit oss-toolchain git helpers
import { run } from "./exec.mjs"; /** * @param {string} [cwd] */ export async function getLatestTag(cwd) { const result = await run("git", ["describe", "--tags", "--abbrev=0"], { cwd, allowFail: true, }); if (!result.ok) { return null; } return result.stdout || null; } /** * @param {string} [cwd] */ export async function isWorkingTreeClean(cwd) { const result = await run("git", ["status", "--porcelain"], { cwd }); return result.stdout.length === 0; } /** * @param {string} [cwd] */ export async function getCurrentBranch(cwd) { const result = await run("git", ["branch", "--show-current"], { cwd }); return result.stdout; } /** * @param {string} fromRef * @param {string} [cwd] */ export async function getCommitsSince(fromRef, cwd) { const range = fromRef ? `${fromRef}..HEAD` : "HEAD"; const result = await run( "git", ["log", range, "--pretty=format:%s|||%h|||%an"], { cwd }, ); if (!result.stdout) { return []; } return result.stdout.split("\n").map((line) => { const [subject, hash, author] = line.split("|||"); return { subject, hash, author }; }); } /** * @param {string} tag * @param {string} message * @param {string} [cwd] */ export async function createTag(tag, message, cwd) { await run("git", ["tag", "-a", tag, "-m", message], { cwd }); } /** * @param {string} [cwd] */ export async function pushTags(cwd) { await run("git", ["push", "--follow-tags"], { cwd }); }
Loading