DOC Document changes to CLI interaction #571
Merged
Conversation
This file contains 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
3 tasks
GuySartorelli
force-pushed
the
pulls/6/symfony-sake
branch
4 times, most recently
from
4a1da0d
to
20ebfd6
Compare
GuySartorelli
force-pushed
the
pulls/6/symfony-sake
branch
2 times, most recently
from
af215b9
to
70249e8
Compare
emteknetnz
requested changes
Sep 23, 2024
| --- | ||
| SilverStripe\Control\Director: | ||
| rules: | ||
| my-command: 'App\Cli\Command\MyPolyCommand' |
There was a problem hiding this comment.
Is this now necessary? Or does protected static string $commandName provide a segment for dev/tasks the way that private static $segment used to?
There was a problem hiding this comment.
This is an optional way that custom poly commands can be routed for access via an HTTP request.
This is not necessary for BuildTask or DevCommand.
en/08_Changelogs/6.0.0.md
Outdated
Comment on lines
257
to
262
| You would now access the `/dev/my-action` action via an HTTP request only. The `/dev/my-other-action` action can be access via an HTTP request, or by using `sake app:my-other-action` on the command line. | ||
|
|
||
| The `some-var` option can be used in a query string when running the action via an HTTP request, or as a flag (e.g. `sake app:my-other-action --some-var`) in CLI. |
There was a problem hiding this comment.
Suggested change
| You would now access the `/dev/my-action` action via an HTTP request only. The `/dev/my-other-action` action can be access via an HTTP request, or by using `sake app:my-other-action` on the command line. | |
| The `some-var` option can be used in a query string when running the action via an HTTP request, or as a flag (e.g. `sake app:my-other-action --some-var`) in CLI. | |
| You would now access the `/dev/my-http-only-action` action via an HTTP request only. The `/dev/my-http-and-cli-action` action can be access via an HTTP request, or by using `sake app:my-http-and-cli-action` on the command line. | |
| The `some-var` option can be used in a query string when running the action via an HTTP request, or as a flag (e.g. `sake app:my-http-and-cli-action --some-var`) in CLI. |
en/08_Changelogs/6.0.0.md
Outdated
Comment on lines
200
to
205
| + protected static string $commandName = 'app:my-other-action'; | ||
| + | ||
| + protected static string $description = 'Perform my custom action in dev/my-other-action or via sake app:my-other-action'; |
There was a problem hiding this comment.
Suggested change
| + protected static string $commandName = 'app:my-other-action'; | |
| + | |
| + protected static string $description = 'Perform my custom action in dev/my-other-action or via sake app:my-other-action'; | |
| + protected static string $commandName = 'app:my-http-and-cli-action'; | |
| + | |
| + protected static string $description = 'Perform my custom action in dev/my-http-and-cli-action or via sake app:my-http-and-cli-action'; |
en/08_Changelogs/6.0.0.md
Outdated
| +use Symfony\Component\Console\Input\InputOption; | ||
|
|
||
| -class MyOtherActionController extends Controller implements PermissionProvider | ||
| +class MyOtherActionController extends DevCommand implements PermissionProvider |
There was a problem hiding this comment.
Suggested change
| +class MyOtherActionController extends DevCommand implements PermissionProvider | |
| +class MyHttpAndCliActionController extends DevCommand implements PermissionProvider |
There was a problem hiding this comment.
Done - also updated MyActionController to MyHttpOnlyActionController
| > [!CAUTION] | ||
| > You should run `sake` with the same system user that runs your web server. Otherwise you will have a separate filesystem cache for CLI and you won't be able to flush or warm your webserver cache using Sake. | ||
|
|
||
| Sake doesn't use your project's routing and controllers for normal execution, but if you do specifically need to access an HTTP route in your application from the CLI, you can use the `sake navigate` command. |
There was a problem hiding this comment.
Suggested change
| Sake doesn't use your project's routing and controllers for normal execution, but if you do specifically need to access an HTTP route in your application from the CLI, you can use the `sake navigate` command. | |
| Sake doesn't use your project's routing and controllers for normal execution. However if you do specifically need to access an HTTP route in your application from the CLI, you can use the `sake navigate` command. |
There was a problem hiding this comment.
This is very subjective and you've not given any reasoning for it? I'll make the change to avoid unnecessary ping pong but might be good to say why you want subjective changes like this in future.
| @@ -0,0 +1,172 @@ | |||
| --- | |||
There was a problem hiding this comment.
Rename file to 02_Poly_Commands.md
There was a problem hiding this comment.
Renamed to 02_PolyCommand.md which is what all the links to this page assume the name is.
| @@ -130,5 +130,5 @@ Silverstripe core environment variables are listed here, though you're free to d | |||
| | `SS_MANIFESTCACHE` | The manifest cache to use (defaults to file based caching). Must be a `Psr\Cache\CacheItemPoolInterface`, `Psr\SimpleCache\CacheInterface`, or `SilverStripe\Core\Cache\CacheFactory` class implementation. | | |||
| | `SS_IGNORE_DOT_ENV` | If set, the `.env` file will be ignored. This is good for live to mitigate any performance implications of loading the `.env` file. | | |||
| | `SS_BASE_URL` | The URL to use when it isn't determinable by other means (for example for CLI commands). Should either start with a protocol (e.g. `https://www.example.com`) or with a double forward slash (e.g. `//www.example.com`). | | |||
| | `SS_FLUSH_ON_DEPLOY` | Try to detect deployments through file system modifications and flush on the first request after every deploy. Does not run "dev/build" - only "flush". Possible values are `true` (check for a framework PHP file modification time), `false` (no checks, skip deploy detection) or a path to a specific file or folder to be checked. See [DeployFlushDiscoverer](api:SilverStripe\Core\Startup\DeployFlushDiscoverer) for more details.<br /><br />False by default. | | |||
| | `SS_FLUSH_ON_DEPLOY` | Try to detect deployments through file system modifications and flushes the cache on the first request after every deploy. Note this does not trigger buildin the database. Possible values are `true` (check for a framework PHP file modification time), `false` (no checks, skip deploy detection) or a path to a specific file or folder to be checked. See [DeployFlushDiscoverer](api:SilverStripe\Core\Startup\DeployFlushDiscoverer) for more details.<br /><br />False by default. | | |||
There was a problem hiding this comment.
Suggested change
| | `SS_FLUSH_ON_DEPLOY` | Try to detect deployments through file system modifications and flushes the cache on the first request after every deploy. Note this does not trigger buildin the database. Possible values are `true` (check for a framework PHP file modification time), `false` (no checks, skip deploy detection) or a path to a specific file or folder to be checked. See [DeployFlushDiscoverer](api:SilverStripe\Core\Startup\DeployFlushDiscoverer) for more details.<br /><br />False by default. | | |
| | `SS_FLUSH_ON_DEPLOY` | Try to detect deployments through file system modifications and flushes the cache on the first request after every deploy. Note this does not trigger building the database. Possible values are `true` (check for a framework PHP file modification time), `false` (no checks, skip deploy detection) or a path to a specific file or folder to be checked. See [DeployFlushDiscoverer](api:SilverStripe\Core\Startup\DeployFlushDiscoverer) for more details.<br /><br />False by default. | |
en/08_Changelogs/6.0.0.md
Outdated
Comment on lines
174
to
181
| + my-action: | ||
| + class: 'App\Dev\MyActionController' | ||
| + description: 'Perform my custom action in dev/my-action' | ||
| + commands: | ||
| + my-other-action: 'App\Dev\MyOtherActionCommand' |
There was a problem hiding this comment.
Suggested change
| + my-action: | |
| + class: 'App\Dev\MyActionController' | |
| + description: 'Perform my custom action in dev/my-action' | |
| + commands: | |
| + my-other-action: 'App\Dev\MyOtherActionCommand' | |
| + my-http-only-action: | |
| + class: 'App\Dev\MyHttpOnlyActionController' | |
| + description: 'Perform my custom action in dev/my-http-only-action' | |
| + commands: | |
| + my-http-and-cli-action: 'App\Dev\MyHttpAndCliActionCommand' |
Comment on lines
76
to
78
| - [`can_run_in_cli`](api:SilverStripe\PolyExecution\PolyCommand->can_run_in_cli): Whether the command can be run in CLI | ||
| - [`can_run_in_browser`](api:SilverStripe\PolyExecution\PolyCommand->can_run_in_browser): Whether the command can be run in HTTP requests | ||
| - [`permissions_for_browser_execution`](api:SilverStripe\PolyExecution\PolyCommand->permissions_for_browser_execution): An array of permissions a user must have to run the command in an HTTP request |
There was a problem hiding this comment.
Suggested change
| - [`can_run_in_cli`](api:SilverStripe\PolyExecution\PolyCommand->can_run_in_cli): Whether the command can be run in CLI | |
| - [`can_run_in_browser`](api:SilverStripe\PolyExecution\PolyCommand->can_run_in_browser): Whether the command can be run in HTTP requests | |
| - [`permissions_for_browser_execution`](api:SilverStripe\PolyExecution\PolyCommand->permissions_for_browser_execution): An array of permissions a user must have to run the command in an HTTP request | |
| - [`can_run_in_cli`](api:SilverStripe\PolyExecution\PolyCommand->can_run_in_cli): Whether the command can be run in CLI | |
| - [`can_run_in_browser`](api:SilverStripe\PolyExecution\PolyCommand->can_run_in_browser): Whether the command can be run in HTTP requests | |
| - [`permissions_for_browser_execution`](api:SilverStripe\PolyExecution\PolyCommand->permissions_for_browser_execution): An array of permissions of which the user must have at least one have to run the command in an HTTP request |
By default Permission::check() will use any not all
There was a problem hiding this comment.
Clarified in a different way (based on the comment in the main issue I assumed there would be no suggestion here so I made the change before I saw this)
emteknetnz
requested changes
Sep 23, 2024
|
|
||
| class MyCustomTask extends BuildTask | ||
| { | ||
| protected static string $commandName = 'my-custom-task'; |
There was a problem hiding this comment.
Suggested change
| protected static string $commandName = 'my-custom-task'; | |
| protected static string $commandName = 'MyCustomTask'; |
I've recommended we use a $commandName that matches the short classname for all BuildTasks, so we should probably recommend the same convention in our docs
There was a problem hiding this comment.
Discussion about this is ongoing in the issue.
Comment on lines
144
to
147
| For example, the following will run `MyTask` every minute. | ||
|
|
||
| ```bash | ||
| * * * * * /your/site/folder/vendor/bin/sake tasks:my-task |
There was a problem hiding this comment.
Suggested change
| For example, the following will run `MyTask` every minute. | |
| ```bash | |
| * * * * * /your/site/folder/vendor/bin/sake tasks:my-task | |
| For example, the following will run `MyCustomTask` every minute. | |
| ```bash | |
| * * * * * /your/site/folder/vendor/bin/sake tasks:MyCustomTask |
There was a problem hiding this comment.
Discussion about this is ongoing in the issue.
en/08_Changelogs/6.0.0.md
Outdated
|
|
||
| For actions that should only be accessible in the browser, you only need to change how these are registered. Move them from `DevelopmentAdmin.registered_controllers` to the new [`DevelopmentAdmin.controllers`](api:SilverStripe\Dev\DevelopmentAdmin->controllers) configuration property. | ||
|
|
||
| Controllers added to `DevelopmentAdmin.registered_controllers` can only be accessed via HTTP requests, so you can remove any logic around CLI usage. |
There was a problem hiding this comment.
Suggested change
| Controllers added to `DevelopmentAdmin.registered_controllers` can only be accessed via HTTP requests, so you can remove any logic around CLI usage. | |
| Controllers added to `DevelopmentAdmin.controllers` can only be accessed via HTTP requests, so you can remove any logic around CLI usage. |
en/08_Changelogs/6.0.0.md
Outdated
Comment on lines
153
to
157
| - `/dev/my-action`: intended for use in the browser only, but you'd have to add custom logic in `init()` to disallow its use in CLI until now | ||
| - `/dev/my-other-action`: intended for use both in CLI and in the browser. |
There was a problem hiding this comment.
Suggested change
| - `/dev/my-action`: intended for use in the browser only, but you'd have to add custom logic in `init()` to disallow its use in CLI until now | |
| - `/dev/my-other-action`: intended for use both in CLI and in the browser. | |
| - `/dev/my-http-only-action`: intended for use in the browser only, but you'd have to add custom logic in `init()` to disallow its use in CLI until now | |
| - `/dev/my-http-and-cli-action`: intended for use both in CLI and in the browser. |
en/08_Changelogs/6.0.0.md
Outdated
|
|
||
| For actions that should only be accessible in the browser, you only need to change how these are registered. Move them from `DevelopmentAdmin.registered_controllers` to the new [`DevelopmentAdmin.controllers`](api:SilverStripe\Dev\DevelopmentAdmin->controllers) configuration property. | ||
|
|
||
| Controllers added to `DevelopmentAdmin.registered_controllers` can only be accessed via HTTP requests, so you can remove any logic around CLI usage. |
There was a problem hiding this comment.
Suggested change
| Controllers added to `DevelopmentAdmin.registered_controllers` can only be accessed via HTTP requests, so you can remove any logic around CLI usage. | |
| Controllers added to `DevelopmentAdmin.controllers` can only be accessed via HTTP requests, so you can remove any logic around CLI usage. |
There was a problem hiding this comment.
Duplicate of #571 (comment)?
en/08_Changelogs/6.0.0.md
Outdated
| } | ||
| ``` | ||
|
|
||
| You would now access the `/dev/my-action` action via an HTTP request only. The `/dev/my-other-action` action can be access via an HTTP request, or by using `sake app:my-other-action` on the command line. |
There was a problem hiding this comment.
Suggested change
| You would now access the `/dev/my-action` action via an HTTP request only. The `/dev/my-other-action` action can be access via an HTTP request, or by using `sake app:my-other-action` on the command line. | |
| You would now access the `/dev/my-http-only-action` action via an HTTP request only. The `/dev/my-http-and-cli-action` action can be access via an HTTP request, or by using `sake app:my-http-and-cli-action` on the command line. |
There was a problem hiding this comment.
Done.... I think this is a duplicate suggestion? Or else you suggested other related changes way earlier and now it's hard to tell if this is a duplicate or just related.
Done in any case.
| Sake used to have functionality to make daemon processes for your application. This functionality was managed with `sake -start my-process` and `sake -stop my-process`. | ||
|
|
||
| We've removed this functionality. Please use an appropriate daemon tool such as `systemctl` to manage these instead. | ||
|
|
There was a problem hiding this comment.
Need to mention dont_populate being renamed to no-populate
There was a problem hiding this comment.
That's not related to sake -start and sake -stop, but I've added a note about it to the relevant place.
GuySartorelli
force-pushed
the
pulls/6/symfony-sake
branch
from
70249e8
to
4ef81b8
Compare
GuySartorelli
force-pushed
the
pulls/6/symfony-sake
branch
from
4ef81b8
to
50c1633
Compare
emteknetnz
approved these changes
Sep 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Reflects changes in silverstripe/silverstripe-framework#11353
Issue