From 5ce2908950c59c3d3e4dcd1c929dcbc85723fdd7 Mon Sep 17 00:00:00 2001 From: Patrick Connolly Date: Fri, 15 Jan 2016 17:44:19 -0800 Subject: [PATCH 1/8] Added MIT license. --- LICENSE.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..77541f3 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2016 Patrick Connolly + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From 36050fd50e69f8e4d87926aa15bb6e4baff71598 Mon Sep 17 00:00:00 2001 From: Patrick Connolly Date: Fri, 15 Jan 2016 18:03:28 -0800 Subject: [PATCH 2/8] Added README note on contributors. --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 830d7e2..df67281 100644 --- a/README.md +++ b/README.md @@ -95,3 +95,8 @@ pupa update ca_on_toronto # [scraper1 scraper2, ...] # Unset envvars to make sure we're not acting on Heroku DB later unset DATABASE_URL OCD_DIVISION_CSV ``` + +### Contributors + +See the [contributors +graph](https://github.com/patcon/tocityhall-api/graphs/contributors). From 4d6f7d2c17ef1362933f536acf22da15923fb1ce Mon Sep 17 00:00:00 2001 From: Patrick Connolly Date: Fri, 15 Jan 2016 18:15:58 -0800 Subject: [PATCH 3/8] Added deployment section to README. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index df67281..a2daabc 100644 --- a/README.md +++ b/README.md @@ -96,6 +96,22 @@ pupa update ca_on_toronto # [scraper1 scraper2, ...] unset DATABASE_URL OCD_DIVISION_CSV ``` +## Deployment + +We are using Heroku Pipelines for deployment. + +![Heroku Pipeline screenshot](https://imgur.com/8KGbCbM.png) + +This means: + +* Code is auto-deployed from `master` to the [*staging + app*](https://tocityhall-api-staging.herokuapp.com/v0). +* Code is promoted from the *staging app* to the [*production + app*](https://tocityhall-api.herokuapp.com/v0). +* Staging and production have their own databases. +* *Review apps* are created for each pull request (linked inline), and + connected to the staging database. + ### Contributors See the [contributors From 26d01b77d274f31765d767e6dcdaa468757b3eaf Mon Sep 17 00:00:00 2001 From: Patrick Connolly Date: Fri, 15 Jan 2016 18:20:26 -0800 Subject: [PATCH 4/8] README fixup. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a2daabc..a4a8f25 100644 --- a/README.md +++ b/README.md @@ -106,7 +106,7 @@ This means: * Code is auto-deployed from `master` to the [*staging app*](https://tocityhall-api-staging.herokuapp.com/v0). -* Code is promoted from the *staging app* to the [*production +* Code is promoted on-demand from the *staging app* to the [*production app*](https://tocityhall-api.herokuapp.com/v0). * Staging and production have their own databases. * *Review apps* are created for each pull request (linked inline), and From 26900f9288650d4137f989ed03bfbf6ad2a3f34b Mon Sep 17 00:00:00 2001 From: Patrick Connolly Date: Fri, 15 Jan 2016 18:22:58 -0800 Subject: [PATCH 5/8] README fixup. --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a4a8f25..6315866 100644 --- a/README.md +++ b/README.md @@ -104,12 +104,12 @@ We are using Heroku Pipelines for deployment. This means: -* Code is auto-deployed from `master` to the [*staging - app*](https://tocityhall-api-staging.herokuapp.com/v0). -* Code is promoted on-demand from the *staging app* to the [*production - app*](https://tocityhall-api.herokuapp.com/v0). +* Code is auto-deployed from `master` to the [**staging + app**](https://tocityhall-api-staging.herokuapp.com/v0). +* Code is promoted on-demand from the **staging app** to the [**production + app**](https://tocityhall-api.herokuapp.com/v0). * Staging and production have their own databases. -* *Review apps* are created for each pull request (linked inline), and +* **Review apps** are created for each pull request (linked inline), and connected to the staging database. ### Contributors From fdf56cf675e8db5990d5bd586e83f4ce728d69f0 Mon Sep 17 00:00:00 2001 From: Patrick Connolly Date: Fri, 15 Jan 2016 18:26:31 -0800 Subject: [PATCH 6/8] Added pipeline link to README. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6315866..bfba79d 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,8 @@ unset DATABASE_URL OCD_DIVISION_CSV ## Deployment -We are using Heroku Pipelines for deployment. +We are using [Heroku +Pipelines](https://devcenter.heroku.com/articles/pipelines) for deployment. ![Heroku Pipeline screenshot](https://imgur.com/8KGbCbM.png) From 7fdb617b71f5adc921fbd3d4a4d81854b8d74fca Mon Sep 17 00:00:00 2001 From: Patrick Connolly Date: Fri, 15 Jan 2016 18:37:06 -0800 Subject: [PATCH 7/8] Clarify lack of review apps on forks. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bfba79d..74644a7 100644 --- a/README.md +++ b/README.md @@ -110,8 +110,9 @@ This means: * Code is promoted on-demand from the **staging app** to the [**production app**](https://tocityhall-api.herokuapp.com/v0). * Staging and production have their own databases. -* **Review apps** are created for each pull request (linked inline), and - connected to the staging database. +* **Review apps** are automatically created for each pull request from a + branch in the main repo (ie. not forks). These apps are connected to +the staging database. ### Contributors From 33d840f3b74f90509e97ec6a6f2432325f9886b8 Mon Sep 17 00:00:00 2001 From: Patrick Connolly Date: Fri, 15 Jan 2016 18:39:05 -0800 Subject: [PATCH 8/8] Add example link to review app PR. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 74644a7..489ce8e 100644 --- a/README.md +++ b/README.md @@ -113,6 +113,7 @@ This means: * **Review apps** are automatically created for each pull request from a branch in the main repo (ie. not forks). These apps are connected to the staging database. +[[Example]](https://github.com/patcon/tocityhall-api/pull/6) ### Contributors