[2/] Improvement: Introduce new command structure #16

zeyadkhaled · 2024-01-31T13:49:38Z

Part of an effort to improve the osdk cli.
The work to get the improvements across will be done over the followings PRs:
[1/] Add new utility functions
[2/] Introduce new command structure --> this
[3/] Use loadedToken for fetching data

This PR

Deleted the following subfolders under site:

versions
upload
delete

Updated the following subfolder under site:

deploy

Added the following subfolders under site:

version
- list
- set
- unset
- delete
- get

The cli now depends on a the config file (if found) to set default values to arguments and decide on behavior of the commands conflicting.

New Command Structure

If a project config file(foundry.config.json) with required values is provided, most of these commands without additional arguments.

osdk unstable site version list List application versions
osdk unstable site version set Set the live site version
osdk unstable site version unset Clear the currently set live site ve
osdk unstable site version delete Delete the specified site version.
osdk unstable site version get Get the currently set live site version
osdk unstable site deploy Deploy an uploaded version

Considerations

All requests are still being made using FOUNDRY_SDK_AUTH_TOKEN environment variable, the token and tokenFile arguments aren't respected yet. This will be handled in part 3.

changelog-app · 2024-02-05T16:21:46Z

Generate changelog in `packages/cli/changelog/@unreleased`

What do the change types mean?

feature: A new feature of the service.
improvement: An incremental improvement in the functionality or operation of the service.
fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
and external consumers of the service's API (e.g. customer-written software or integrations).
deprecation: Advertises the intention to remove service functionality without any change to the
operation of the service itself.
manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
performing database surgery, ...) at the time of upgrade for it to succeed.
migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?

❗The break and manual task changelog types will result in a major release!
🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
✨ All others will result in a minor version release.

Type

Description

[2/] Improvement: Introduce new command structure

Check the box to generate changelog(s)

Generate changelog entry

packages/cli/src/cli.ts

packages/cli/src/commands/site/deploy/handleSiteDeploy.mts

packages/cli/src/commands/site/deploy/siteDeployArgs.ts

packages/cli/src/commands/site/deploy/handleSiteDeploy.mts

packages/cli/src/commands/site/deploy/index.ts

packages/cli/src/commands/site/version/delete/versionDeleteCommand.mts

packages/cli/src/commands/site/deploy/handleSiteDeploy.mts

packages/cli/src/cli.ts

packages/cli/src/util/configLoader.ts

packages/cli/src/commands/site/version/delete/versionDeleteCommand.mts

packages/cli/src/commands/site/version/get/versionGetCommand.mts

packages/cli/src/commands/site/deploy/siteDeployCommand.mts

packages/cli/src/commands/site/version/index.ts

packages/cli/src/commands/site/deploy/index.ts

packages/cli/src/yargs/logConfigFileMiddleware.ts

packages/cli/src/commands/site/index.ts

* origin/main: Autorelease Increase CLI max width to 150 columns (#47) Debug log site zip stats (#49) Clean up yargs and consola imports (#51) Autorelease Add generated changelog entries Breaking: force dollar sign in osdk verbs for where Display errors more consistently in @osdk/cli (#41) Fix tagPrefix Add generated changelog entries Create foundry.config.json in create-app [3/] Improvement: Use loadedToken for fetching data (#17) Move argv override logging to middleware (#42) Make sure to run all tests (#39) Update create-app to use FOUNDRY_TOKEN in templates (#40) Add generated changelog entries Fix intellisense for aggregations and fill in more number types [2/] Improvement: Introduce new command structure (#16) Autorelease Refactor create-app prompts with tests (#32) Refactor create-app dotfile generation (#31) add changelog Add generated changelog entries Add generated changelog entries put mkdir in right place remove generated files add ignore for legacy client remove deleted file added add back mkdir move mkdir fix fixes keep trying remove module shared testing infra for legacy

zeyadkhaled mentioned this pull request Jan 31, 2024

[1/] Improvement: Add utility functions for CLI improvements #15

Merged

zeyadkhaled assigned tzyl Jan 31, 2024

zeyadkhaled force-pushed the zka/cli-command-structure branch from b62c622 to 4c5f507 Compare January 31, 2024 15:15

zeyadkhaled mentioned this pull request Jan 31, 2024

[3/] Improvement: Use loadedToken for fetching data #17

Merged

zeyadkhaled force-pushed the zka/cli-command-structure branch 4 times, most recently from f0a9df2 to 9b328c5 Compare February 2, 2024 16:58

Base automatically changed from zka/cli-utils to main February 5, 2024 16:21

zeyadkhaled force-pushed the zka/cli-command-structure branch 3 times, most recently from faf9d93 to 886b2fd Compare February 5, 2024 16:55

tzyl reviewed Feb 6, 2024

View reviewed changes

zeyadkhaled added 9 commits February 6, 2024 14:38

Delete old commands

0163f38

Update CommonSiteArgs

3497333

Add new commands

b3c2ad5

Load config file and pass it to siteHandler

562ee3c

Lint fix

c4c7cf8

Use SiteConfig type and add TODO

2b60a0c

Small fix

844a33e

Add debug logs and comments

c606860

Handling for autoVersion

2816993

zeyadkhaled force-pushed the zka/cli-command-structure branch from e8e4a7b to 2816993 Compare February 6, 2024 14:38

zeyadkhaled added 6 commits February 6, 2024 14:43

Small fix

3abcce9

CRs

9d5f8ca

Use a lazy config loader

4edc715

delete lowercase args files

c9b75ff

Small refactor

ba338d9

Log configFilePath in a middleware

c486951

zeyadkhaled added 5 commits February 7, 2024 10:25

Remove TODOs

16a72b0

Handle trailing slashes in site command

5b538ee

Make clients respect verbosity flag

22e2a0c

Fix configLoader return type

1164d33

Add site command test

b9c65d8

tzyl reviewed Feb 7, 2024

View reviewed changes

zeyadkhaled added 2 commits February 7, 2024 12:28

CRs

b9e878f

import CommandModule directly for consisteny

b3d2dfe

zeyadkhaled requested a review from tzyl February 7, 2024 12:31

tzyl approved these changes Feb 7, 2024

View reviewed changes

zeyadkhaled added 4 commits February 7, 2024 13:19

CRs

9b822b1

Add eqeqeq eslint rule

506dc8c

fix lint

492f361

undo eslint change

c1dda28

zeyadkhaled added the merge when ready label Feb 7, 2024

bulldozer-bot bot merged commit 16efd1e into main Feb 7, 2024
5 of 7 checks passed

bulldozer-bot bot deleted the zka/cli-command-structure branch February 7, 2024 13:40

zeyadkhaled mentioned this pull request Feb 7, 2024

Move argv override logging to middleware #42

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[2/] Improvement: Introduce new command structure #16

[2/] Improvement: Introduce new command structure #16

zeyadkhaled commented Jan 31, 2024 •

edited

Loading

changelog-app bot commented Feb 5, 2024

[2/] Improvement: Introduce new command structure #16

[2/] Improvement: Introduce new command structure #16

Conversation

zeyadkhaled commented Jan 31, 2024 • edited Loading

This PR

New Command Structure

Considerations

changelog-app bot commented Feb 5, 2024

Generate changelog in packages/cli/changelog/@unreleased

zeyadkhaled commented Jan 31, 2024 •

edited

Loading

Generate changelog in `packages/cli/changelog/@unreleased`