Compare commits

..
3 Commits
Author SHA1 Message Date
github-actions[bot] e0538e6866 v1.5.2 2025-05-10 11:25:48 +00:00
github-actions[bot] 42d5417623 Version Packages (#476)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-05-10 13:25:20 +02:00
Sam LanningandMateusz Burzyński 3c24abeab2 Make git add work consistently with subdirectories (#473)
* Make git add work consistently with subdirectories

Currently, depending on your `commitMode`,
when running the action with `cwd` set to a subdirectory of a repo,
the action will either:

- `git-cli`: add the files changed in the subdirectory only
- `github-api`: add files changed anywhere in the repository

This commit brings github-api in line with git-cli,
so that it only adds files in the current working directory.

* Explicitly set `cwd` for all exec calls

* Avoid using `ExecOptions` from `@actions/exec`

* Rename type

* remove redundant `filter`

---------

Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
2025-05-10 12:34:27 +02:00
6 changed files with 77 additions and 40 deletions
+9
View File
@@ -1,5 +1,14 @@
# @changesets/action # @changesets/action
## 1.5.2
### Patch Changes
- [#473](https://github.com/changesets/action/pull/473) [`3c24abe`](https://github.com/changesets/action/commit/3c24abeab26da6335c181222faa2ea485a092cf8) Thanks [@s0](https://github.com/s0)! - Make git add work consistently with subdirectories
Ensure that when running the action from a subdirectory of a repository,
only the files from that directory are added, regardless of `commitMode`.
## 1.5.1 ## 1.5.1
### Patch Changes ### Patch Changes
+1 -1
View File
File diff suppressed because one or more lines are too long
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "@changesets/action", "name": "@changesets/action",
"version": "1.5.1", "version": "1.5.2",
"main": "dist/index.js", "main": "dist/index.js",
"license": "MIT", "license": "MIT",
"devDependencies": { "devDependencies": {
+54 -31
View File
@@ -4,60 +4,75 @@ import * as github from "@actions/github";
import { commitChangesFromRepo } from "@changesets/ghcommit/git"; import { commitChangesFromRepo } from "@changesets/ghcommit/git";
import { Octokit } from "./octokit"; import { Octokit } from "./octokit";
const push = async (branch: string, { force }: { force?: boolean } = {}) => { type GitOptions = {
await exec( cwd: string;
"git",
["push", "origin", `HEAD:${branch}`, force && "--force"].filter<string>(
Boolean as any
)
);
}; };
const switchToMaybeExistingBranch = async (branch: string) => { const push = async (branch: string, options: GitOptions) => {
await exec("git", ["push", "origin", `HEAD:${branch}`, "--force"], options);
};
const switchToMaybeExistingBranch = async (
branch: string,
options: GitOptions
) => {
let { stderr } = await getExecOutput("git", ["checkout", branch], { let { stderr } = await getExecOutput("git", ["checkout", branch], {
ignoreReturnCode: true, ignoreReturnCode: true,
...options,
}); });
let isCreatingBranch = !stderr let isCreatingBranch = !stderr
.toString() .toString()
.includes(`Switched to a new branch '${branch}'`); .includes(`Switched to a new branch '${branch}'`);
if (isCreatingBranch) { if (isCreatingBranch) {
await exec("git", ["checkout", "-b", branch]); await exec("git", ["checkout", "-b", branch], options);
} }
}; };
const reset = async ( const reset = async (pathSpec: string, options: GitOptions) => {
pathSpec: string, await exec("git", ["reset", `--hard`, pathSpec], options);
mode: "hard" | "soft" | "mixed" = "hard"
) => {
await exec("git", ["reset", `--${mode}`, pathSpec]);
}; };
const commitAll = async (message: string) => { const commitAll = async (message: string, options: GitOptions) => {
await exec("git", ["add", "."]); await exec("git", ["add", "."], options);
await exec("git", ["commit", "-m", message]); await exec("git", ["commit", "-m", message], options);
}; };
const checkIfClean = async (): Promise<boolean> => { const checkIfClean = async (options: GitOptions): Promise<boolean> => {
const { stdout } = await getExecOutput("git", ["status", "--porcelain"]); const { stdout } = await getExecOutput(
"git",
["status", "--porcelain"],
options
);
return !stdout.length; return !stdout.length;
}; };
export class Git { export class Git {
octokit; readonly octokit: Octokit | null;
constructor(octokit?: Octokit) { readonly cwd: string;
this.octokit = octokit;
constructor(args: { octokit?: Octokit; cwd: string }) {
this.octokit = args.octokit ?? null;
this.cwd = args.cwd;
} }
async setupUser() { async setupUser() {
if (this.octokit) { if (this.octokit) {
return; return;
} }
await exec("git", ["config", "user.name", `"github-actions[bot]"`]); await exec("git", ["config", "user.name", `"github-actions[bot]"`], {
await exec("git", [ cwd: this.cwd,
});
await exec(
"git",
[
"config", "config",
"user.email", "user.email",
`"41898282+github-actions[bot]@users.noreply.github.com"`, `"41898282+github-actions[bot]@users.noreply.github.com"`,
]); ],
{
cwd: this.cwd,
}
);
} }
async pushTag(tag: string) { async pushTag(tag: string) {
@@ -73,7 +88,7 @@ export class Git {
core.warning(`Failed to create tag ${tag}: ${err.message}`); core.warning(`Failed to create tag ${tag}: ${err.message}`);
}); });
} }
await exec("git", ["push", "origin", tag]); await exec("git", ["push", "origin", tag], { cwd: this.cwd });
} }
async prepareBranch(branch: string) { async prepareBranch(branch: string) {
@@ -81,12 +96,19 @@ export class Git {
// Preparing a new local branch is not necessary when using the API // Preparing a new local branch is not necessary when using the API
return; return;
} }
await switchToMaybeExistingBranch(branch); await switchToMaybeExistingBranch(branch, { cwd: this.cwd });
await reset(github.context.sha); await reset(github.context.sha, { cwd: this.cwd });
} }
async pushChanges({ branch, message }: { branch: string; message: string }) { async pushChanges({ branch, message }: { branch: string; message: string }) {
if (this.octokit) { if (this.octokit) {
/**
* Only add files form the current working directory
*
* This will emulate the behavior of `git add .`,
* used in {@link commitAll}.
*/
const addFromDirectory = this.cwd;
return commitChangesFromRepo({ return commitChangesFromRepo({
octokit: this.octokit, octokit: this.octokit,
...github.context.repo, ...github.context.repo,
@@ -95,12 +117,13 @@ export class Git {
base: { base: {
commit: github.context.sha, commit: github.context.sha,
}, },
addFromDirectory,
force: true, force: true,
}); });
} }
if (!(await checkIfClean())) { if (!(await checkIfClean({ cwd: this.cwd }))) {
await commitAll(message); await commitAll(message, { cwd: this.cwd });
} }
await push(branch, { force: true }); await push(branch, { cwd: this.cwd });
} }
} }
+7 -2
View File
@@ -15,11 +15,12 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
return; return;
} }
const inputCwd = core.getInput("cwd"); const inputCwd = getOptionalInput("cwd");
if (inputCwd) { if (inputCwd) {
core.info("changing directory to the one given as the input"); core.info("changing directory to the one given as the input");
process.chdir(inputCwd); process.chdir(inputCwd);
} }
const cwd = inputCwd || process.cwd();
const octokit = setupOctokit(githubToken); const octokit = setupOctokit(githubToken);
const commitMode = getOptionalInput("commitMode") ?? "git-cli"; const commitMode = getOptionalInput("commitMode") ?? "git-cli";
@@ -27,7 +28,10 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
core.setFailed(`Invalid commit mode: ${commitMode}`); core.setFailed(`Invalid commit mode: ${commitMode}`);
return; return;
} }
const git = new Git(commitMode === "github-api" ? octokit : undefined); const git = new Git({
octokit: commitMode === "github-api" ? octokit : undefined,
cwd
});
let setupGitUser = core.getBooleanInput("setupGitUser"); let setupGitUser = core.getBooleanInput("setupGitUser");
@@ -100,6 +104,7 @@ const getOptionalInput = (name: string) => core.getInput(name) || undefined;
git, git,
octokit, octokit,
createGithubReleases: core.getBooleanInput("createGithubReleases"), createGithubReleases: core.getBooleanInput("createGithubReleases"),
cwd,
}); });
if (result.published) { if (result.published) {
+2 -2
View File
@@ -66,7 +66,7 @@ type PublishOptions = {
octokit: Octokit; octokit: Octokit;
createGithubReleases: boolean; createGithubReleases: boolean;
git: Git; git: Git;
cwd?: string; cwd: string;
}; };
type PublishedPackage = { name: string; version: string }; type PublishedPackage = { name: string; version: string };
@@ -85,7 +85,7 @@ export async function runPublish({
git, git,
octokit, octokit,
createGithubReleases, createGithubReleases,
cwd = process.cwd(), cwd,
}: PublishOptions): Promise<PublishResult> { }: PublishOptions): Promise<PublishResult> {
let [publishCommand, ...publishArgs] = script.split(/\s+/); let [publishCommand, ...publishArgs] = script.split(/\s+/);