Merge pull request #8011 from open-sausages/pulls/4/upgrader-env-cmd-doc

Update framework doc to reflect upgrader environment functionality
This commit is contained in:
Damian Mooyman 2018-04-18 16:32:53 +12:00 committed by GitHub
commit 5e39dc3687
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 13 deletions

View File

@ -68,6 +68,17 @@ You'll need to move your constants to a new `.env` file before SilverStripe will
For further details about the `.env` migration, read through the For further details about the `.env` migration, read through the
[`_ss_environment.php` changed to `.env` section](/changelogs/4.0.0#env) [`_ss_environment.php` changed to `.env` section](/changelogs/4.0.0#env)
If you have installed the upgrader tool, you can use the `environment` command to generate a valid `.env` file from your
existing `_ss_environment.php` file.
```
cd ~/my-project-root
upgrade-code environment --write
```
Read the [upgrader `environment` command documentation](https://github.com/silverstripe/silverstripe-upgrader/blob/master/docs/en/environment.md)
for more details.
## Using the upgrader tool ## Using the upgrader tool
We've developed [an upgrader tool](https://github.com/silverstripe/silverstripe-upgrader) which you can use to help We've developed [an upgrader tool](https://github.com/silverstripe/silverstripe-upgrader) which you can use to help

View File

@ -134,3 +134,11 @@ and are replaced by the `SiteTreeLink` and `FileLink` many_many through joining
Code which relies on raw SQL queries to these tables will need to be updated. Code which relies on raw SQL queries to these tables will need to be updated.
`SiteTreeFileExtension` is deprecated, and has it's functionality baked directly into `File` dataobject. `SiteTreeFileExtension` is deprecated, and has it's functionality baked directly into `File` dataobject.
### New upgrader command
The SilverStripe upgrader tool can now be used to convert your `_ss_environment.php` file to an equivalent `.env` file when migrating a SilverStripe 3 project to SilverStripe 4.
```
cd ~/my-project-root
upgrade-code environment --write
```