Skip to content

Commit

Permalink
Fix order of readme bullet point and clarify TERMINUS_SITE (#29)
Browse files Browse the repository at this point in the history
* Moving pbcopy reference in readme

* Update README.md

* comma fix
  • Loading branch information
stevector authored Jun 28, 2019
1 parent 9f7f412 commit 4818703
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,10 @@ Those can be copied in one command using the [Terminus Build Tools Plugin](https
3. Set up SSH keys and environment variables.
* Pantheon requires SSH keys for performing git interactions. CircleCI needs a private key that matches a public key connected to your Pantheon account (or another account with access to the Pantheon site in question).
* Create a new SSH key on your local machine in a tmp directory with `ssh-keygen -m PEM -t rsa -b 4096 -f /tmp/new_key_for_ci -N ''`.
* `pbcopy` is a command installed by default on MacOS systems. If you use a different operating system you may need to copy and paste the SSH key values manually. See the [Pantheon SSH key documentation](https://pantheon.io/docs/ssh-keys/) for more information on SSH key generation.
* Copy the newly created public key (`cat /tmp/new_key_for_ci.pub | pbcopy`) and [add it to your Pantheon account](https://pantheon.io/docs/ssh-keys/).
* `pbcopy` is a command installed by default on MacOS systems. If you use a different operating system you may need to copy and paste the SSH key values manually. See the [Pantheon SSH key documentation](https://pantheon.io/docs/ssh-keys/) for more information on SSH key generation.
* Copy the private key (`cat /tmp/new_key_for_ci | pbcopy`) and add it to your CircleCI configuration by using the "SSH Permissions" settings. Set the hostname as `drush.in` and paste your private key into the text box.
* Under Environment Variables in your CircleCI settings add a variable for `TERMINUS_SITE` set to the machine name of your Pantheon site.
* The machine name of your site is simply the site name in all lowercase with spaces replaced by dashes. For example, `My CircleCI Orb Test` would be `my-circleci-orb-test`.
* Under Environment Variables in your CircleCI settings add a variable for `TERMINUS_SITE` set to the machine name of your Pantheon site. If you don't know the machine name of your site, look at the URL of the Dev or Test environment of the site. For example in the URL for a Dev environment, `https://dev-pantheon-weekly-demo-site.pantheonsite.io/`, the machine name is `pantheon-weekly-demo-site`.
* [Create a Terminus machine token using the Pantheon Dashboard](https://pantheon.io/docs/machine-tokens/). Add it as another environment variable in CircleCI named `TERMINUS_TOKEN`.
* Retrigger a build in CircleCI either by pushing a whitespace (or otherwise inocuous) change to your code on GitHub. This time, the build should pass.
4. (Optional) Under "Advanced Settings" in your CircleCI repository settings turn on "Only build pull requests." While not necessary, this setting prevents separate Pantheon Multidev environment from being created for each commit. With this setting on, all created Multidevs will be named by pull request number and subsequent pushes to an open pull request will reuse the same Multidev environment.
Expand Down

0 comments on commit 4818703

Please sign in to comment.