-
Notifications
You must be signed in to change notification settings - Fork 12
feat: added bundle create #974
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.
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
dawson-david-salesforce
merged 2 commits into
packagingDistribution/packageBundles
from
t/packaging-distribution/W-18671326/Package-Bundle-Create-command
Jun 12, 2025
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # summary | ||
|
|
||
| Create a bundle. | ||
|
|
||
| # description | ||
|
|
||
| First, use this command to create a bunle. Then create a bundle version. | ||
|
|
||
| Your --name value must be unique within your namespace. | ||
|
|
||
| Run '<%= config.bin %> bundle list to list all bundles in the Dev Hub org. | ||
|
|
||
| # examples | ||
|
|
||
| - Default Use Case | ||
| <%= config.bin %> <%= command.id %> --name <bundle_name> --description "<bundle_description>" --target-dev-hub <dev_hub_alias>` | ||
|
|
||
| # flags.name.summary | ||
|
|
||
| Name of the bundle to create. | ||
|
|
||
| # flags.description.summary | ||
|
|
||
| Description of the bundle |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-07/schema#", | ||
| "$ref": "#/definitions/BundleCreate", | ||
| "definitions": { | ||
| "BundleCreate": { | ||
| "type": "object", | ||
| "properties": { | ||
| "Id": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": ["Id"], | ||
| "additionalProperties": false | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /* | ||
| * Copyright (c) 2025, salesforce.com, inc. | ||
| * All rights reserved. | ||
| * Licensed under the BSD 3-Clause license. | ||
| * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause | ||
| */ | ||
|
|
||
| import { Flags, loglevel, orgApiVersionFlagWithDeprecations, SfCommand } from '@salesforce/sf-plugins-core'; | ||
| import { BundleCreateOptions, PackageBundle } from '@salesforce/packaging'; | ||
| import { Messages } from '@salesforce/core'; | ||
| import { requiredHubFlag } from '../../../utils/hubFlag.js'; | ||
|
|
||
| Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); | ||
| const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'bundle_create'); | ||
| export type BundleCreate = { Id: string }; | ||
|
|
||
| export class PackageBundlesCreate extends SfCommand<BundleCreate> { | ||
| public static readonly summary = messages.getMessage('summary'); | ||
| public static readonly description = messages.getMessage('description'); | ||
| public static readonly examples = messages.getMessages('examples'); | ||
| public static readonly aliases = ['force:bundle:create']; | ||
| public static readonly requiresProject = true; | ||
| public static readonly flags = { | ||
| loglevel, | ||
| name: Flags.string({ | ||
| char: 'n', | ||
| summary: messages.getMessage('flags.name.summary'), | ||
| required: true, | ||
| }), | ||
| description: Flags.string({ | ||
| char: 'd', | ||
| summary: messages.getMessage('flags.description.summary'), | ||
| }), | ||
| 'target-dev-hub': requiredHubFlag, | ||
| 'api-version': orgApiVersionFlagWithDeprecations, | ||
| }; | ||
|
|
||
| public async run(): Promise<BundleCreate> { | ||
| const { flags } = await this.parse(PackageBundlesCreate); | ||
|
|
||
| const options: BundleCreateOptions = { | ||
| Description: flags.description ?? '', | ||
| BundleName: flags.name, | ||
| }; | ||
| this.spinner.start(`Creating Bundle with name ${options.BundleName}`); | ||
| const result = await PackageBundle.create( | ||
| flags['target-dev-hub'].getConnection(flags['api-version']), | ||
| this.project!, | ||
| options | ||
| ); | ||
|
|
||
| this.spinner.stop(); | ||
| this.table({ data: [{ name: 'Bundle Id', value: result.Id }], title: 'Ids' }); | ||
|
|
||
| return result; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /* | ||
| * Copyright (c) 2025, salesforce.com, inc. | ||
| * All rights reserved. | ||
| * Licensed under the BSD 3-Clause license. | ||
| * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause | ||
| */ | ||
| import { Config } from '@oclif/core'; | ||
| import { TestContext, MockTestOrgData } from '@salesforce/core/testSetup'; | ||
| import * as sinon from 'sinon'; | ||
| import { expect } from 'chai'; | ||
| import { BundleCreateOptions, PackageBundle } from '@salesforce/packaging'; | ||
| import { stubSfCommandUx } from '@salesforce/sf-plugins-core'; | ||
| import { Connection, SfProject } from '@salesforce/core'; | ||
| import { PackageBundlesCreate } from '../../../src/commands/package/bundles/create.js'; | ||
|
|
||
| describe('force:bundle:create - tests', () => { | ||
| const $$ = new TestContext(); | ||
| const testOrg = new MockTestOrgData(); | ||
| let sfCommandStubs: ReturnType<typeof stubSfCommandUx>; | ||
| let createStub: sinon.SinonStub<[Connection, SfProject, BundleCreateOptions], Promise<{ Id: string }>>; | ||
| const config = new Config({ root: import.meta.url }); | ||
|
|
||
| beforeEach(async () => { | ||
| await $$.stubAuths(testOrg); | ||
| await config.load(); | ||
| sfCommandStubs = stubSfCommandUx($$.SANDBOX); | ||
|
|
||
| createStub = $$.SANDBOX.stub(PackageBundle, 'create'); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| $$.restore(); | ||
| }); | ||
|
|
||
| it('should create a bundle', async () => { | ||
| const bundleName = 'dummyPackageId'; | ||
| const cmd = new PackageBundlesCreate(['-v', testOrg.username, '--name', bundleName], config); | ||
|
|
||
| createStub.resolves({ Id: 'test-id' }); | ||
|
|
||
| await cmd.run(); | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access | ||
| expect(sfCommandStubs.table.calledOnce).to.be.true; | ||
| }); | ||
|
|
||
| it('should throw error when name flag is missing', async () => { | ||
| const cmd = new PackageBundlesCreate(['-v', testOrg.username], config); | ||
|
|
||
| createStub.resolves({ Id: 'test-id' }); | ||
|
|
||
| try { | ||
| await cmd.run(); | ||
| expect.fail('Expected error was not thrown'); | ||
| } catch (error) { | ||
| expect((error as Error).message).to.include('Missing required flag name'); | ||
| } | ||
| }); | ||
|
|
||
| it('should throw error when test org flag is missing', async () => { | ||
| const cmd = new PackageBundlesCreate(['--name', 'dummyPackageId'], config); | ||
|
|
||
| createStub.resolves({ Id: 'test-id' }); | ||
|
|
||
| try { | ||
| await cmd.run(); | ||
| expect.fail('Expected error was not thrown'); | ||
| } catch (error) { | ||
| expect((error as Error).message).to.include('No default dev hub found'); | ||
| } | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.