From a142cb17d9528bcefcfd8200729f11230c5d95b5 Mon Sep 17 00:00:00 2001 From: Sam Lanning Date: Sat, 10 May 2025 00:34:57 +0100 Subject: [PATCH] Make repo required & remove deprecated arg --- .changeset/afraid-ducks-know.md | 7 +++++++ src/core.ts | 8 +------- src/interface.ts | 4 +--- 3 files changed, 9 insertions(+), 10 deletions(-) create mode 100644 .changeset/afraid-ducks-know.md diff --git a/.changeset/afraid-ducks-know.md b/.changeset/afraid-ducks-know.md new file mode 100644 index 0000000..340a863 --- /dev/null +++ b/.changeset/afraid-ducks-know.md @@ -0,0 +1,7 @@ +--- +"@changesets/ghcommit": major +--- + +Make `repo` argument required, +and remove the `repository` argument which was deprecated +and previously could be used in its place. diff --git a/src/core.ts b/src/core.ts index fa59f4a..ffc640a 100644 --- a/src/core.ts +++ b/src/core.ts @@ -49,7 +49,6 @@ export const commitFilesFromBase64 = async ({ octokit, owner, repo, - repository, branch, base, force = false, @@ -57,14 +56,9 @@ export const commitFilesFromBase64 = async ({ fileChanges, log, }: CommitFilesFromBase64Args): Promise => { - const repositoryNameWithOwner = `${owner}/${repository}`; + const repositoryNameWithOwner = `${owner}/${repo}`; const baseRef = getBaseRef(base); const targetRef = `refs/heads/${branch}`; - repo = repo ?? repository; - - if (!repo) { - throw new Error(`Argument 'repo' must be provided`); - } log?.debug(`Getting repo info ${repositoryNameWithOwner}`); const info = await getRepositoryMetadata(octokit, { diff --git a/src/interface.ts b/src/interface.ts index 282e219..b2c403d 100644 --- a/src/interface.ts +++ b/src/interface.ts @@ -24,9 +24,7 @@ export type GitBase = export interface CommitFilesBasedArgs { octokit: GitHubClient; owner: string; - repo?: string; - /** @deprecated use {@link repo} instead */ - repository?: string; + repo: string; branch: string; /** * Push the commit even if the branch exists and does not match what was