From 298b4cccaa68d4cc7e592c9703d4926cb10bd3ff Mon Sep 17 00:00:00 2001 From: busticated Date: Fri, 12 Jan 2018 09:18:19 -0800 Subject: [PATCH 1/4] [gatsby] don't run service-workers outside of https or localhost see: https://github.com/gatsbyjs/gatsby/issues/3385 --- packages/gatsby/cache-dir/app.js | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/packages/gatsby/cache-dir/app.js b/packages/gatsby/cache-dir/app.js index d9d8b1a33a60f..c1daf37e9e116 100644 --- a/packages/gatsby/cache-dir/app.js +++ b/packages/gatsby/cache-dir/app.js @@ -24,7 +24,7 @@ apiRunnerAsync(`onClientEntry`).then(() => { * * Let's unregister the service workers in development, and tidy up a few errors. */ - if (`serviceWorker` in navigator) { + if (supportsServiceWorkers(location, navigator)) { navigator.serviceWorker.getRegistrations().then(registrations => { for (let registration of registrations) { registration.unregister() @@ -69,3 +69,10 @@ apiRunnerAsync(`onClientEntry`).then(() => { }) } }) + +function supportsServiceWorkers(location, navigator){ + if (location.hostname === `localhost` || location.protocol === `https:`){ + return `serviceWorker` in navigator + } + return false +} From 1ba780edb7e13589631ae79db5a478c1addb36a9 Mon Sep 17 00:00:00 2001 From: busticated Date: Fri, 12 Jan 2018 09:19:41 -0800 Subject: [PATCH 2/4] add detail around running local changes to CONTRIBUTING.md --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b72c8c893dccf..074fbc42f9eaa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,6 +38,11 @@ The usual contributing steps are: the built files from your cloned copy of Gatsby. It'll watch for your changes to Gatsby packages and copy them into the site. For more detailed instructions see the [gatsby-dev-cli README](/packages/gatsby-dev-cli/) +* In each of your test sites' directories, run `yarn install` +* In your test site(s), run `gatsby develop` + - this _may_ cause your `.cache` directory to be reset. if you don't see your + changes, editing the source files in your clone will cause them to be copied + over to your test site again. * Add tests and code for your changes. * Once you're done, make sure all tests still pass: `yarn test` * Commit and push to your fork. From 28a85c674b02e3f484de84da6e86aef42337c25d Mon Sep 17 00:00:00 2001 From: Kyle Mathews Date: Fri, 12 Jan 2018 10:27:24 -0800 Subject: [PATCH 3/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 074fbc42f9eaa..520b134393f6e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,15 +34,11 @@ The usual contributing steps are: build of all packages and then watch for changes to packages' source code and compile these changes on-the-fly as you work. * Install [gatsby-dev-cli](/packages/gatsby-dev-cli/) globally: `yarn global add gatsby-dev-cli` +* Run `yarn install` in each of the sites you're testing with. * For each of your Gatsby test sites, run the `gatsby-dev` command there to copy the built files from your cloned copy of Gatsby. It'll watch for your changes to Gatsby packages and copy them into the site. For more detailed instructions see the [gatsby-dev-cli README](/packages/gatsby-dev-cli/) -* In each of your test sites' directories, run `yarn install` -* In your test site(s), run `gatsby develop` - - this _may_ cause your `.cache` directory to be reset. if you don't see your - changes, editing the source files in your clone will cause them to be copied - over to your test site again. * Add tests and code for your changes. * Once you're done, make sure all tests still pass: `yarn test` * Commit and push to your fork. From 3946c0e5adc556fe24b2734cd731f31ac5fe3a92 Mon Sep 17 00:00:00 2001 From: Kyle Mathews Date: Fri, 12 Jan 2018 10:33:54 -0800 Subject: [PATCH 4/4] format --- docs/docs/deploy-gatsby.md | 6 ++++-- packages/gatsby/cache-dir/app.js | 4 ++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/docs/deploy-gatsby.md b/docs/docs/deploy-gatsby.md index 654511fea83c3..0120e038c0a03 100644 --- a/docs/docs/deploy-gatsby.md +++ b/docs/docs/deploy-gatsby.md @@ -105,9 +105,11 @@ git remote add origin git@gitlab.com:examplerepository git add . git push -u origin master ``` + You can deploy sites on Gitlab Pages with or without a custom domain. If you choose to use the default setup (without a custom domain), or if you create a project site, you will need to setup your site with path prefixing. If adding a custom domain, you can skip the Path Prefix step, and remove `--prefix-paths` from the gitlab-ci.yml file. ### Path Prefix + As the site will be hosted under yourname.gitlab.io/examplerepository/, you will need to configure Gatsby to use the Path Prefix plugin. In the `gatsby-config.js`, set the `pathPrefix` to be added to your site's link @@ -157,12 +159,12 @@ CI stage. You can have multiple stages, e.g. 'Test', 'Build', 'Deploy' etc. `script:` starts the next part of the CI stage, telling it to start running the below scripts inside the image selected. We have used the `yarn install` and `./node_modules/.bin/gatsby build --prefix-paths` which will install all dependancies, and -start the static site build, respectively. +start the static site build, respectively. We have used `./node_modules/.bin/gatsby build --prefix-paths` because we then don't have to install gatsby-cli to build the image, as it has already been included and installed -with `yarn install`. We have included `--prefix-paths` as when running the command *without* that flag, Gatsby ignores your pathPrefix. `artifacts:` and `paths:` are used to tell GitLab pages +with `yarn install`. We have included `--prefix-paths` as when running the command _without_ that flag, Gatsby ignores your pathPrefix. `artifacts:` and `paths:` are used to tell GitLab pages where the static files are kept. `only:` and `master` tells the CI to only run the above instructions when the master branch is deployed. diff --git a/packages/gatsby/cache-dir/app.js b/packages/gatsby/cache-dir/app.js index c1daf37e9e116..e64f76cb8ceb7 100644 --- a/packages/gatsby/cache-dir/app.js +++ b/packages/gatsby/cache-dir/app.js @@ -70,8 +70,8 @@ apiRunnerAsync(`onClientEntry`).then(() => { } }) -function supportsServiceWorkers(location, navigator){ - if (location.hostname === `localhost` || location.protocol === `https:`){ +function supportsServiceWorkers(location, navigator) { + if (location.hostname === `localhost` || location.protocol === `https:`) { return `serviceWorker` in navigator } return false