Skip to content

[SDK-7461] fix(setup-env): do not export a build/project name the workflow never set #87

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

Open
rounak610 wants to merge 2 commits into
base: master
Choose a base branch
from
+110 −15
Open

[SDK-7461] fix(setup-env): do not export a build/project name the workflow never set #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6365c7
fix(setup-env): do not override a build/project name the workflow nev…
shivamku-BS Sep 2, 2026
d2e8a43
fix(setup-env): trim verbose comments per review
rounak610 Sep 7, 2026
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
7 changes: 4 additions & 3 deletions setup-env/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

This action sets up the following environment variables in the runner environment. These environment variables shall be used in the tests for BrowserStack:

1. `BROWSERSTACK_BUILD_NAME`: This environment variable is set on the basis of the input to `build-name` field. By default, the value will be decided based on the event, i.e. push, pull_request etc for the workflow:
1. `BROWSERSTACK_BUILD_NAME`: This environment variable is set **only when you pass the `build-name` input**. If you do not pass it, the variable is left unset so that the build name configured in your own test setup (e.g. `browserstack.json` / `browserstack.yml`) is used. Pass the `BUILD_INFO` keyword to get a name generated from the event, i.e. push, pull_request etc for the workflow:
1. `push` event: `[<Branch-Name>] Commit <commit-sha>: <commit-message> [Workflow: <Workflow-number>]`
2. `pull_request` event: `[<Branch-Name>] PR <PR-number>: <PR-title> [Workflow: <Workflow-number>]`
3. `release` event: `[<Branch-Name>] Release <Release-tag>: <Release-name> [Workflow: <Workflow-number>]`
4. Other events: `<Event-Name> [Workflow: <Workflow-number>]`

2. `BROWSERSTACK_PROJECT_NAME`: This environment variable is set on the basis of the input to `project-name` field. By default, i.e. if any input is not provided, the value will be set as the Repository Name.
2. `BROWSERSTACK_PROJECT_NAME`: This environment variable is set **only when you pass the `project-name` input**. If you do not pass it, the variable is left unset so that the project name configured in your own test setup is used. Pass the `REPO_NAME` keyword to use the Repository Name.
3. `BROWSERSTACK_USERNAME`: This environment variable's value is taken from the input to `username` field. Ideal way would be to pass the GitHub Secret as the input, i.e. `username: ${{ secrets.BROWSERSTACK_USERNAME }}`.
4. `BROWSERSTACK_ACCESS_KEY`: This environment variable's value is taken from the input to `access-key` field. Ideal way would be to pass the GitHub Secret as the input, i.e. `access-key: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}`.

Expand Down Expand Up @@ -46,10 +46,11 @@ or
* `build-name: BUILD_INFO - My String at the end`
* `build-name: String at the Beginning - BUILD_INFO - String at the end`
* The keyword `BUILD_INFO` will be replaced by the information based on the event of the workflow as described above for `BROWSERSTACK_BUILD_NAME` environment variable.
* If you omit this input entirely, `BROWSERSTACK_BUILD_NAME` is **not** exported and your own configured build name is left untouched.
* `project-name`: (**Optional**)
* You can pass any string that you want to set as the `BROWSERSTACK_PROJECT_NAME`. E.g. `project-name: My Project Name Goes Here`.
* You can also pass the keyword `REPO_NAME` as the input. This will set the Repository Name for the `BROWSERSTACK_PROJECT_NAME` environment variable.
* If no input is provided, `REPO_NAME` will be considered as the default input.
* If you omit this input entirely, `BROWSERSTACK_PROJECT_NAME` is **not** exported and your own configured project name is left untouched.

---
**NOTE**
Expand Down
26 changes: 20 additions & 6 deletions setup-env/dist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34599,6 +34599,10 @@ class ActionInput {
// non-compulsory fields
this.buildName = core.getInput(INPUT.BUILD_NAME);
this.projectName = core.getInput(INPUT.PROJECT_NAME);

// Capture before _validateInput() replaces blanks with generated defaults.
this.buildNameProvided = Boolean(this.buildName && this.buildName.trim());
this.projectNameProvided = Boolean(this.projectName && this.projectName.trim());
this.githubApp = core.getInput(INPUT.GITHUB_APP);

@shayan-bstack shayan-bstack Sep 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Trim it here as well

@rounak610 rounak610 Sep 7, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in d2e8a43 — this is the bundled dist; regenerated with npm run build (ncc) after trimming the source comment, so it now carries the shortened version.

this.githubToken = core.getInput(INPUT.GITHUB_TOKEN);
this.rerunAttempt = process?.env?.GITHUB_RUN_ATTEMPT;
Expand Down Expand Up @@ -34632,13 +34636,23 @@ class ActionInput {
core.exportVariable(ENV_VARS.BROWSERSTACK_ACCESS_KEY, this.accessKey);
core.info(`Use ${ENV_VARS.BROWSERSTACK_ACCESS_KEY} environment variable for your access key in your tests\n`);

core.exportVariable(ENV_VARS.BROWSERSTACK_PROJECT_NAME, this.projectName);
core.info(`${ENV_VARS.BROWSERSTACK_PROJECT_NAME} environment variable set as: ${this.projectName}`);
core.info(`Use ${ENV_VARS.BROWSERSTACK_PROJECT_NAME} environment variable for your project name capability in your tests\n`);
// Export only when supplied: an env var outranks the user's browserstack.json,
// so a generated default would silently replace it. BUILD_INFO / REPO_NAME opt in.
if (this.projectNameProvided) {
core.exportVariable(ENV_VARS.BROWSERSTACK_PROJECT_NAME, this.projectName);
core.info(`${ENV_VARS.BROWSERSTACK_PROJECT_NAME} environment variable set as: ${this.projectName}`);
core.info(`Use ${ENV_VARS.BROWSERSTACK_PROJECT_NAME} environment variable for your project name capability in your tests\n`);
} else {
core.info(`No project-name input given, so ${ENV_VARS.BROWSERSTACK_PROJECT_NAME} was left unset and your own configuration will be used. Pass project-name (or the REPO_NAME token) to set it here.\n`);
}

core.exportVariable(ENV_VARS.BROWSERSTACK_BUILD_NAME, this.buildName);
core.info(`${ENV_VARS.BROWSERSTACK_BUILD_NAME} environment variable set as: ${this.buildName}`);
core.info(`Use ${ENV_VARS.BROWSERSTACK_BUILD_NAME} environment variable for your build name capability in your tests\n`);
if (this.buildNameProvided) {
core.exportVariable(ENV_VARS.BROWSERSTACK_BUILD_NAME, this.buildName);
core.info(`${ENV_VARS.BROWSERSTACK_BUILD_NAME} environment variable set as: ${this.buildName}`);
core.info(`Use ${ENV_VARS.BROWSERSTACK_BUILD_NAME} environment variable for your build name capability in your tests\n`);
} else {
core.info(`No build-name input given, so ${ENV_VARS.BROWSERSTACK_BUILD_NAME} was left unset and your own configuration will be used. Pass build-name (or the BUILD_INFO token) to set it here.\n`);
}

if (await this.checkIfBStackReRun()) {
await this.setBStackRerunEnvVars();
Expand Down
26 changes: 20 additions & 6 deletions setup-env/src/actionInput/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ class ActionInput {
// non-compulsory fields
this.buildName = core.getInput(INPUT.BUILD_NAME);
this.projectName = core.getInput(INPUT.PROJECT_NAME);

// Capture before _validateInput() replaces blanks with generated defaults.
this.buildNameProvided = Boolean(this.buildName && this.buildName.trim());
this.projectNameProvided = Boolean(this.projectName && this.projectName.trim());
this.githubApp = core.getInput(INPUT.GITHUB_APP);
this.githubToken = core.getInput(INPUT.GITHUB_TOKEN);
this.rerunAttempt = process?.env?.GITHUB_RUN_ATTEMPT;
Expand Down Expand Up @@ -65,13 +69,23 @@ class ActionInput {
core.exportVariable(ENV_VARS.BROWSERSTACK_ACCESS_KEY, this.accessKey);
core.info(`Use ${ENV_VARS.BROWSERSTACK_ACCESS_KEY} environment variable for your access key in your tests\n`);

core.exportVariable(ENV_VARS.BROWSERSTACK_PROJECT_NAME, this.projectName);
core.info(`${ENV_VARS.BROWSERSTACK_PROJECT_NAME} environment variable set as: ${this.projectName}`);
core.info(`Use ${ENV_VARS.BROWSERSTACK_PROJECT_NAME} environment variable for your project name capability in your tests\n`);
// Export only when supplied: an env var outranks the user's browserstack.json,
// so a generated default would silently replace it. BUILD_INFO / REPO_NAME opt in.
if (this.projectNameProvided) {
core.exportVariable(ENV_VARS.BROWSERSTACK_PROJECT_NAME, this.projectName);
core.info(`${ENV_VARS.BROWSERSTACK_PROJECT_NAME} environment variable set as: ${this.projectName}`);
core.info(`Use ${ENV_VARS.BROWSERSTACK_PROJECT_NAME} environment variable for your project name capability in your tests\n`);
} else {
core.info(`No project-name input given, so ${ENV_VARS.BROWSERSTACK_PROJECT_NAME} was left unset and your own configuration will be used. Pass project-name (or the REPO_NAME token) to set it here.\n`);
}

core.exportVariable(ENV_VARS.BROWSERSTACK_BUILD_NAME, this.buildName);
core.info(`${ENV_VARS.BROWSERSTACK_BUILD_NAME} environment variable set as: ${this.buildName}`);
core.info(`Use ${ENV_VARS.BROWSERSTACK_BUILD_NAME} environment variable for your build name capability in your tests\n`);
if (this.buildNameProvided) {
core.exportVariable(ENV_VARS.BROWSERSTACK_BUILD_NAME, this.buildName);
core.info(`${ENV_VARS.BROWSERSTACK_BUILD_NAME} environment variable set as: ${this.buildName}`);
core.info(`Use ${ENV_VARS.BROWSERSTACK_BUILD_NAME} environment variable for your build name capability in your tests\n`);
} else {
core.info(`No build-name input given, so ${ENV_VARS.BROWSERSTACK_BUILD_NAME} was left unset and your own configuration will be used. Pass build-name (or the BUILD_INFO token) to set it here.\n`);
}

if (await this.checkIfBStackReRun()) {
await this.setBStackRerunEnvVars();
Expand Down
66 changes: 66 additions & 0 deletions setup-env/test/actionInput/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,36 @@ describe('Action Input operations for fetching all inputs, triggering validation
expect(actionInput.projectName).to.eq('validatedProjectName');
});

it('Records that build-name and project-name were supplied', () => {
stubbedInput.withArgs(INPUT.BUILD_NAME).returns('someBuildName');
stubbedInput.withArgs(INPUT.PROJECT_NAME).returns('someProjectName');
const actionInput = new ActionInput();
// eslint-disable-next-line no-unused-expressions
expect(actionInput.buildNameProvided).to.be.true;
// eslint-disable-next-line no-unused-expressions
expect(actionInput.projectNameProvided).to.be.true;
});

it('Records that build-name and project-name were NOT supplied when absent', () => {
stubbedInput.withArgs(INPUT.BUILD_NAME).returns('');
stubbedInput.withArgs(INPUT.PROJECT_NAME).returns('');
const actionInput = new ActionInput();
// eslint-disable-next-line no-unused-expressions
expect(actionInput.buildNameProvided).to.be.false;
// eslint-disable-next-line no-unused-expressions
expect(actionInput.projectNameProvided).to.be.false;
});

it('Treats a whitespace-only name input as not supplied', () => {
stubbedInput.withArgs(INPUT.BUILD_NAME).returns(' ');
stubbedInput.withArgs(INPUT.PROJECT_NAME).returns('\t ');
const actionInput = new ActionInput();
// eslint-disable-next-line no-unused-expressions
expect(actionInput.buildNameProvided).to.be.false;
// eslint-disable-next-line no-unused-expressions
expect(actionInput.projectNameProvided).to.be.false;
});

it('Takes input and throws error if username is not provided in input', () => {
stubbedInput.withArgs(INPUT.USERNAME, { required: true }).throws(Error('Username Required'));
try {
Expand Down Expand Up @@ -94,6 +124,9 @@ describe('Action Input operations for fetching all inputs, triggering validation
actionInput.accessKey = 'someAccessKey';
actionInput.buildName = 'someBuildName';
actionInput.projectName = 'someProjectName';
// _fetchAllInput is stubbed out above, so these flags have to be set by hand.
actionInput.buildNameProvided = true;
actionInput.projectNameProvided = true;

// Stub checkIfBStackReRun to return true
sinon.stub(actionInput, 'checkIfBStackReRun').returns(Promise.resolve(true));
Expand All @@ -111,6 +144,39 @@ describe('Action Input operations for fetching all inputs, triggering validation
sinon.assert.calledWith(core.exportVariable, ENV_VARS.BROWSERSTACK_BUILD_NAME, 'someBuildName');
});

it('Does not export BROWSERSTACK_PROJECT_NAME when no project-name input was given', () => {
actionInput.projectNameProvided = false;
actionInput.setEnvVariables();
sinon.assert.neverCalledWith(
core.exportVariable, ENV_VARS.BROWSERSTACK_PROJECT_NAME, sinon.match.any,
);
// the other variables are unaffected
sinon.assert.calledWith(core.exportVariable, ENV_VARS.BROWSERSTACK_BUILD_NAME, 'someBuildName');
sinon.assert.calledWith(core.exportVariable, ENV_VARS.BROWSERSTACK_USERNAME, 'someUsername');
});

it('Does not export BROWSERSTACK_BUILD_NAME when no build-name input was given', () => {
actionInput.buildNameProvided = false;
actionInput.setEnvVariables();
sinon.assert.neverCalledWith(
core.exportVariable, ENV_VARS.BROWSERSTACK_BUILD_NAME, sinon.match.any,
);
sinon.assert.calledWith(core.exportVariable, ENV_VARS.BROWSERSTACK_PROJECT_NAME, 'someProjectName');
sinon.assert.calledWith(core.exportVariable, ENV_VARS.BROWSERSTACK_ACCESS_KEY, 'someAccessKey');
});

it('Exports neither name when neither input was given, leaving the user config to win', () => {
actionInput.buildNameProvided = false;
actionInput.projectNameProvided = false;
actionInput.setEnvVariables();
sinon.assert.neverCalledWith(
core.exportVariable, ENV_VARS.BROWSERSTACK_BUILD_NAME, sinon.match.any,
);
sinon.assert.neverCalledWith(
core.exportVariable, ENV_VARS.BROWSERSTACK_PROJECT_NAME, sinon.match.any,
);
});

it('Calls setBStackRerunEnvVars when checkIfBStackReRun returns true', async () => {
const setBStackRerunEnvVarsStub = sinon.stub(actionInput, 'setBStackRerunEnvVars').resolves();
await actionInput.setEnvVariables();
Expand Down
Loading