-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
90d83e3
commit adadfb1
Showing
1 changed file
with
9 additions
and
35 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,13 @@ | ||
| # WordPress | ||
| ## Basic GitHub Actions Workflow Example | ||
|
|
||
| This is a WordPress repository configured to run on the [Pantheon platform](https://pantheon.io). | ||
| This repo contains a base WordPress site, using Pantheon's WordPress upstream. Currently, it is connected to a PS Architecture site, called [Miriam Workflows WP](https://admin.dashboard.pantheon.io/sites/09905707-7c13-4b78-af75-598ddf537458#dev/code). | ||
|
|
||
| Pantheon is website platform optimized and configured to run high performance sites with an amazing developer workflow. There is built-in support for features such as Varnish, Redis, Apache Solr, New Relic, Nginx, PHP-FPM, MySQL, PhantomJS and more. | ||
| It uses a very basic GitHub actions to deploy to Pantheon on PR creation, code sync, and merge to `main`. Below outline the secrets and variables needed to successfully configure the workflow. This are configured via the repo settings, under Secrets and variables -> Actions. | ||
|
|
||
| ## Getting Started | ||
| This workflow currently only supports one site. More complex workflows will be made available in separate repos. | ||
|
|
||
| ### 1. Spin-up a site | ||
|
|
||
| If you do not yet have a Pantheon account, you can create one for free. Once you've verified your email address, you will be able to add sites from your dashboard. Choose "WordPress" to use this distribution. | ||
|
|
||
| ### 2. Load up the site | ||
|
|
||
| When the spin-up process is complete, you will be redirected to the site's dashboard. Click on the link under the site's name to access the Dev environment. | ||
|
|
||
|  | ||
|
|
||
| ### 3. Run the WordPress installer | ||
|
|
||
| How about the WordPress database config screen? No need to worry about database connection information as that is taken care of in the background. The only step that you need to complete is the site information and the installation process will be complete. | ||
|
|
||
| We will post more information about how this works but we recommend developers take a look at `wp-config.php` to get an understanding. | ||
|
|
||
|  | ||
|
|
||
| If you would like to keep a separate set of configuration for local development, you can use a file called `wp-config-local.php`, which is already in our .gitignore file. | ||
|
|
||
| ### 4. Enjoy! | ||
|
|
||
|  | ||
|
|
||
| ## Branches | ||
|
|
||
| The `default` branch of this repository is where PRs are merged, and has [CI](https://github.com/pantheon-systems/WordPress/tree/default/.circleci) that copies `default` to `master` after removing the CI directories. This allows customers to clone from `master` and implement their own CI without needing to worry about potential merge conflicts. | ||
|
|
||
| ## Custom Upstreams | ||
|
|
||
| If you are using this repository as a starting point for a custom upstream, be sure to review the [documentation](https://pantheon.io/docs/create-custom-upstream#pull-in-core-from-pantheons-upstream) and pull the core files from the `master` branch. | ||
| | Type | Name | Purpose | | ||
| | --- | --- | --- | | ||
| | Secret | TERMINUS_TOKEN | Terminus machine token for deploying code. | | ||
| | Variable | ORG_GUID | GUID of the organization that is responsible for the site. | | ||
| | Variable | SITE_NAME | Name of the site in the Pantheon Dashboard. | |