W-16286213 feat: make project optional #771

cristiand391 · 2024-08-12T19:59:51Z

DEPENDS ON https://github.com/forcedotcom/packaging/pull/638/files

What does this PR do?

forcedotcom/cli#2932

Allow the following commands to be run outside an sfdx project:

package delete
package update
package version delete
package version displayancestry
package version list
package version promote
package version report

What issues does this PR fix or reference?

@W-16286213@

cristiand391 · 2024-08-13T14:32:53Z

src/commands/package/version/list.ts

  public async run(): Promise<PackageVersionListCommandResult> {
    const { flags } = await this.parse(PackageVersionListCommand);
    const connection = flags['target-dev-hub'].getConnection(flags['api-version']);
-    const project = SfProject.getInstance();


this command didn't have requiresProject = true but this line was enforcing it anyway.

cristiand391 · 2024-08-13T14:34:06Z

test/commands/package/packageVersionCreate.test.ts

 import Package2VersionStatus = PackagingSObjects.Package2VersionStatus;

-const pkgVersionCreateErrorResult: Partial<PackageVersionCreateRequestResult> = {
+const pkgVersionCreateErrorResult: PackageVersionCreateRequestResult = {


this type changed here:
forcedotcom/packaging#627

mshanemc

why does package:version:update need a Project? It doesn't look like it's reading the project (flags for tag, branch, etc passed as inputs to the method).

I'm going to ask Vivek about the sfdx-projecet modification commetns.

mshanemc · 2024-08-14T20:50:57Z

src/commands/package/version/delete.ts

  public static readonly examples = messages.getMessages('examples');
  public static readonly deprecateAliases = true;
  public static readonly aliases = ['force:package:version:delete'];
-  public static readonly requiresProject = true;


hmm...[unrelated to this PR] I would have expected the delete command to remove the packageVersion from my project.

I guess it never has (and this was that whole "delete doesn't really delete, just deprecates" so maybe that's correct?)

so maybe that should happen if there's a project, but it's not required?

mshanemc · 2024-08-14T20:53:14Z

src/commands/package/delete.ts

  public static readonly examples = messages.getMessages('examples');
  public static readonly deprecateAliases = true;
  public static readonly aliases = ['force:package:delete'];
-  public static readonly requiresProject = true;


also would have expected this to modify sfdx-project after deleting the pkg

mshanemc · 2024-08-14T20:57:35Z

src/commands/package/update.ts

  public static readonly examples = messages.getMessages('examples');
  public static readonly deprecateAliases = true;
  public static readonly aliases = ['force:package:update'];
-  public static readonly requiresProject = true;


same (I'd expect it to update the packageDirectories description/etc with my changes)

@mshanemc - I tested something similar with package version update.

I updated the --version-name and --version-description. Both were updated in the DevHub, but neither impacted sfdx-project.json

mshanemc · 2024-08-14T21:00:21Z

src/utils/getProject.ts

+  } catch (err) {
+    if (err instanceof Error && err.name === 'InvalidProjectWorkspaceError') {
+      return undefined;
+    }


any swallow all other errors?
What's the logic of checking the error name then?

What's the logic of checking the error name then?

none, I think I was just following the error msg from SfProject.resolve's jsdoc.
Changed to make it swallow all errors that could come from trying to resolve a project.

VivekMChawla · 2024-08-14T22:17:13Z

why does package:version:update need a Project? It doesn't look like it's reading the project (flags for tag, branch, etc passed as inputs to the method).

I'm going to ask Vivek about the sfdx-projecet modification commetns.

@mshanemc - Perhaps package version update wants to update versionName or versionDescription in the relevant packageDirectory object inside sfdx-project.json?

This would only happen if the --version-name or --version-description flags were used with the command.

I've tested this from inside a project. I updated the --version-name and --version-description. Both were updated in the DevHub, but neither impacted sfdx-project.json.

mshanemc · 2024-08-15T14:42:13Z

qa notes

outside a project (from this repo)

package version list
[FIXED] ❌ I think the aliases column should be empty (or omitted entirely!) when there's no Project. As is, it's listing the IDs.

✅ package version report -p 04tKY000000HDvHYAW
✅ package version report -p foo

Error (ErrorInvalidPackageVersionIdError): The provided alias or ID: [foo] could not be resolved to a valid package version ID (05i) or subscriber package version ID (04t).

💡 I wonder how often the cause of that error is going to be "you're not in the project you think you are" and whether maybe it should say that. [another idea would be to spit out some valid aliases if you think that's what they're trying to do]

✅ displayancestry

src/commands/package/version/list.ts

…in-packaging into cd/no-project

mshanemc · 2024-08-15T17:54:51Z

QA cont

✅ package version delete does
✅ package version promote tries to (I chose one without code coverage, so it throws, but not because of the project and it IS able to find the package version)

cristiand391 added 5 commits August 12, 2024 13:40

feat: no project required

4d7980f

test: fix stubs

ad7d8a7

chore: bump packaging

5629581

fix: manually resolve project

19a8750

test: remove only

3b17032

cristiand391 mentioned this pull request Aug 13, 2024

W-16286213 feat: make SfProject optional forcedotcom/packaging#638

Merged

fix: package version list too

7837ada

cristiand391 commented Aug 13, 2024

View reviewed changes

cristiand391 marked this pull request as ready for review August 13, 2024 14:34

cristiand391 changed the title ~~Cd/no project~~ feat: make project optional Aug 13, 2024

mshanemc reviewed Aug 14, 2024

View reviewed changes

chore: pr review

5faf172

mshanemc approved these changes Aug 15, 2024

View reviewed changes

ci: disable package1 nuts

726e04b

mshanemc reviewed Aug 15, 2024

View reviewed changes

src/commands/package/version/list.ts Show resolved Hide resolved

cristiand391 and others added 2 commits August 15, 2024 12:50

fix: empty alias when if no project

d834e2f

Merge branch 'cd/no-project' of https://github.com/salesforcecli/plug…

caafdc6

…in-packaging into cd/no-project

mshanemc added 3 commits August 15, 2024 15:10

chore: bump deps

7a47bed

fix(deps): bump lots of deps

35d77b4

test: update for error change from lib

81af695

mshanemc merged commit 5f674ee into main Aug 15, 2024

mshanemc deleted the cd/no-project branch August 15, 2024 20:37

iowillhoit changed the title ~~feat: make project optional~~ W-16286213 feat: make project optional Jan 27, 2025

W-16286213 feat: make project optional #771

W-16286213 feat: make project optional #771

Uh oh!

Conversation

cristiand391 commented Aug 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

What issues does this PR fix or reference?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mshanemc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

VivekMChawla commented Aug 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mshanemc commented Aug 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

mshanemc commented Aug 15, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

cristiand391 commented Aug 12, 2024 •

edited

Loading

VivekMChawla commented Aug 14, 2024 •

edited

Loading

mshanemc commented Aug 15, 2024 •

edited

Loading