emelie/zola
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Expand Netlify doc page

Browse source 
This commit expands the Netlify documentation page to include a
description of how to manually deploy a built Gutenberg site from the
command line.
This commit is contained in:
Daniel Sockwell 2018-07-25 13:42:46 -04:00
parent c2d4561f05
commit ffe6f2b5f0
1 changed files with 23 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/content/documentation/deployment/netlify.md
View file

@ -8,13 +8,16 @@ with no effort. This very site is hosted by Netlify and automatically deployed o
If you don't have an account with Netlify, you can [sign up](https://app.netlify.com) for one.
## Automatic Deploys
Once you are in the admin interface, you can add a site from a Git provider (GitHub, GitLab or Bitbucket). At the end
of this process, you can select the deploy settings for the project:
- build command: `GUTENBERG_VERSION=0.3.1 gutenberg build` (replace the version number in the variable by the version you want to use)
- build command: `GUTENBERG_VERSION=0.3.3 gutenberg build` (replace the version number in the variable by the version you want to use)
- publish directory: the path to where the `public` directory is
With this setup, your site should be automatically deployed on every commit on master.
With this setup, your site should be automatically deployed on every commit on master. For `GUTENBERG_VERSION`, you may
use any of the tagged `release` versions in the GitHub repository—Netlify will automatically fetch the tagged version
and use it to build your site.
However, if you want to use everything that Netlify gives you, you should also publish temporary sites for pull requests.
@ -31,7 +34,7 @@ command = "gutenberg build"
[build.environment]
# Set the version name that you want to use and Netlify will automatically use it
GUTENBERG_VERSION = "0.3.1"
GUTENBERG_VERSION = "0.3.3"
# The magic for deploying previews of branches
# We need to override the base url with what the url of the preview is ($DEPLOY_PRIME_URL)
@ -41,4 +44,21 @@ command = "gutenberg build --base-url $DEPLOY_PRIME_URL"
```
## Manual Deploys
If you would prefer to use a version of Gutenberg that isn't a tagged release (for example, after having built Gutenberg from
source and made modifications), then you will need to manually deploy your `public` folder to Netlify. You can do this through
Netlify's web GUI or via the command line.
For a command-line manual deploy, follow these steps:
1. Generate a `Personal Access Token` from the settings section of your Netlify account (*not* an OAuth Application)
2. Build your site with `gutenberg build`
3. Create a zip folder containing the `public` directory
4. Run the `curl` command below, filling in your values for PERSONAL_ACCESS_TOKEN_FROM_STEP_1, FILE_NAME.zip and SITE_NAME
5. (Optional) delete the zip folder
```bash
curl -H "Content-Type: application/zip" \
-H "Authorization: Bearer PERSONAL_ACCESS_TOKEN_FROM_STEP_1" \
--data-binary "@FILE_NAME.zip" \
https://api.netlify.com/api/v1/sites/SITE_NAME.netlify.com/deploys
```