8000 Add a flag to install and upgrade commands to not start Appwrite by stnguyen90 · Pull Request #7271 · appwrite/appwrite · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add a flag to install and upgrade commands to not start Appwrite #7271

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
merged 2 commits into from
Jan 8, 2024

Conversation

stnguyen90
Copy link
Contributor
@stnguyen90 stnguyen90 commented Dec 11, 2023

This can be useful for cases where the developer only wants the files to be generated and doesn't want to start Appwrite.

What does this PR do?

Closes #7223

Test Plan

Manually ran install:

image

Manually ran upgrade:

image

Related PRs and Issues

Checklist

  • Have you read the Contributing Guidelines on issues?
  • If the PR includes a change to an API's metadata (desc, label, params, etc.), does it also include updated API specs and example docs?

This can be useful for cases where the developer only wants the files
to be generated and doesn't want to start Appwrite.
@stnguyen90 stnguyen90 requested a review from eldadfux December 12, 2023 01:34
@@ -29,10 +30,11 @@ public function __construct()
->param('organization', 'appwrite', new Text(0), 'Docker Registry organization', true)
->param('image', 'appwrite', new Text(0), 'Main appwrite docker image', true)
->param('interactive', 'Y', new Text(1), 'Run an interactive session', true)
->callback(fn ($httpPort, $httpsPort, $organization, $image, $interactive) => $this->action($httpPort, $httpsPort, $organization, $image, $interactive));
->param('noStart', false, new Boolean(true), 'Run an interactive session', true)
Copy link
Member

Choose a reason for hiding this comment

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

Should this be camelCase or dash-case?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I did camel because httpPort and httpsPort are camelCase. That said, in CLIs dash-case is more common.

Copy link
Member

Choose a reason for hiding this comment

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

Will it be a breaking change if we adapt our style? do we have inconsistencies in other places?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it'll be a breaking change if people are using these scripts and passing the params camelCase. We would have to update utopia-php/cli to support both camelCase and dash-case for backwards compatbility.

This is the only command that has multiple words so it's the only one that has camelCase.

Copy link
Contributor Author
@stnguyen90 stnguyen90 Jan 8, 2024

Choose a reason for hiding this comment

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

Eldad said:

if we correct the styling and update the docs, the impact should be 0 for current users. Any reasons not to fix it?

@eldadfux, if someone has some script that uses the old syntax, it will break. I do agree the impact is small, though. That said, I've updated the arguments. Here's the test:

image

Kebab case like --http-port is much more common in CLIs than --httpPort.
@eldadfux eldadfux merged commit ef72e08 into main Jan 8, 2024
@stnguyen90 stnguyen90 deleted the feat-7223-install-without-start branch April 25, 2024 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

🚀 Feature: Update the install command to allow not starting Appwrite
2 participants
0