Skip to content

Commit 2236a71

Browse files
committed
Updated README, CHANGELOG, and LICENCE for v2.0.1 release
1 parent de8e448 commit 2236a71

3 files changed

Lines changed: 32 additions & 13 deletions

File tree

CHANGELOG.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22
All notable changes to this project will be documented in this file.
33
This project adheres to [Semantic Versioning](http://semver.org/).
44

5+
## [2.0.1] - 2018-10-07
6+
#### Added
7+
- Allowing the user to overload `DOCROOT` at run-time with `SYMPHONY_DOCROOT` environment variable (Closes #6).
8+
9+
#### Changes
10+
- Added checks to make sure composer autoloader exists and display nice message it it cannot be located (Closes #5)
11+
- Updated `Utils::promptForInput()` to allow setting of the prompt character. Default is still colon (:)
12+
13+
514
## [2.0.0] - 2016-07-03
615
#### Added
716
- The hasRequiresAuthenticationTrait trait will now prompt for username and password if none was provided.
@@ -105,7 +114,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
105114
#### Added
106115
- Initial release
107116

108-
[Unreleased]: https://github.com/pointybeard/shell/compare/v2.0.0...integration
117+
[Unreleased]: https://github.com/pointybeard/shell/compare/v2.0.1...integration
118+
[2.0.1]: https://github.com/pointybeard/shell/compare/v2.0.0...v2.0.1
109119
[2.0.0]: https://github.com/pointybeard/shell/compare/v1.0.4...v2.0.0
110120
[1.0.4]: https://github.com/pointybeard/shell/compare/v1.0.3...v1.0.4
111121
[1.0.3]: https://github.com/pointybeard/shell/compare/v1.0.2...v1.0.3

LICENCE

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
All source code included in the "Shell" archive is,
1+
All source code included in the "Shell Extension for Symphony CMS" archive is,
22
unless otherwise specified, released under the MIT licence as follows:
33

44
----- begin license block -----
55

6-
Copyright 2015 Alistair Kearney
6+
Copyright 2015-2018 Alannah Kearney
77

88
Permission is hereby granted, free of charge, to any person obtaining a copy
99
of this software and associated documentation files (the "Software"), to deal
@@ -23,4 +23,4 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2323
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2424
THE SOFTWARE.
2525

26-
----- end license block -----
26+
----- end license block -----

README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Shell Extension for Symphony CMS
22

3-
- Version: v2.0.0
4-
- Date: July 3 2016
3+
- Version: v2.0.1
4+
- Date: October 7 2018
55
- [Release notes](https://github.com/pointybeard/shell/blob/master/CHANGELOG.md)
66
- [GitHub repository](https://github.com/pointybeard/shell)
77

@@ -51,13 +51,13 @@ or, if you followed the "Optional Setup" above, just
5151
### Getting Started
5252

5353
The Shell extension looks for commands in the `bin/` folder of extensions you have installed, and also in `workspace/bin/`. You can see a list of commands by running `symphony` without any arguments. A list like this will be displayed:
54-
54+
```
5555
Below is a list of all available commands. (use --usage for details on
5656
executing individual commands):
5757
5858
shell/hello
5959
shell/token
60-
60+
```
6161
At any time you can use `--usage`, `--help` or `-h` to get help. If you have also specified a command (see below), you will get help for that particular command instead.
6262

6363
Use the `-c` or `--command` argument to run a particular command. The value provided is always `[extension]/[command]` or `[workspace]/[command]`. This extension comes with two commands out of the box: `hello` and `token`.
@@ -67,10 +67,10 @@ To run the `hello` command use the following:
6767
symphony -c shell/hello
6868

6969
You should see output like this:
70-
70+
```
7171
Hello! Here are the arguments you passed me.
7272
0: 'c' => 'shell/hello'
73-
73+
```
7474
### Authentication
7575

7676
Some commands may require you are authenticated before you use them. To do this, either provide the name of the user you want to authenticate as with `-u <username>` or the auth token of that user with `-t <token>`. When using `-u`, you will be prompted to enter your password.
@@ -148,11 +148,20 @@ Note that if you follow the "Optional Steps" above, running `symphony` will alwa
148148

149149
If you run multiple sites across multiple installations of Symphony, remember that the Shell extension will work with only the installation of Symphony it itself was installed and enabled on.
150150

151-
A workaround to this is to use the symlink method and namespace each install.
151+
A solution is to place the Shell extension folder outside of the Symphony CMS install, symlink the it into each `extensions/` folder per install of Symphony, and provide the path to Symphony at run-time with `$SYMPHONY_DOCROOT`.
152+
153+
E.g.
152154

153-
For example, you have two sites "Banana" and "Apple". Both are separate installations of Symphony with their own databases. Symlink them using `ln -s /path/to/banana/extension/shell/bin/symphony /usr/local/sbin/symphony-banana` and `ln -s /path/to/banana/extension/shell/bin/symphony /usr/local/sbin/symphony-apple`. Now you can use this shell extension for both and know you are always in the correct context (`> symphony-banana` and `> symphony-apple`).
155+
One install of Symphony is called banana and another called apple. The same shell extension folder, which is in `~/source` is symlinked accordingly into `extensions` folder.
156+
```
157+
## ln -s ~/source/shell /var/www/symphony-banana/extensions/
158+
SYMPHONY_DOCROOT=/var/www/symphony-banana symphony
159+
160+
## ln -s ~/source/shell /var/www/symphony-banana/extensions/
161+
SYMPHONY_DOCROOT=/var/www/symphony-apple symphony
162+
```
154163

155-
In the future there might be better support for running a single shell instance across all Symphony installations on a host.
164+
Using `SYMPHONY_DOCROOT` like this gives the Shell extension context and will load up the correct install of Symphony at run-time.
156165

157166
## Support
158167

0 commit comments

Comments
 (0)