From 5d3900f27b6ad310f503244380367dc2c3da770a Mon Sep 17 00:00:00 2001
From: Achilleas Pipinellis <axilleas@axilleas.me>
Date: Mon, 6 Feb 2017 12:42:31 +0100
Subject: [PATCH 1/2] Add detailed instructions how to update GDK with webpack
---
CHANGELOG.md | 35 +++++++++++++++++++++++++++++++++++
1 file changed, 35 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9d4dbfd..52d6fee 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,41 @@ features.
- Add webpack process to Procfile configure it within gitlab.yml !237
+ For existing GDK installations, manual action is required to update GDK.
+ Assuming `origin` is the upstream repo, do the following:
+
+ 1. First, update the CE/EE repo:
+
+ ```
+ cd <gitlab-ce-dir>
+ git pull origin master
+ bundle install && npm purge && npm install
+ bundle exec rake webpack:compile
+ ```
+
+ 1. Pull the new GDK changes:
+
+ ```
+ cd <gdk-dir>
+ git pull origin master
+ ```
+
+ 1. Make sure postgres is running:
+
+ ```
+ cd <gdk-dir>
+ gdk run db
+ ```
+
+ 1. Then, **open a separate terminal window** and update GDK along with all its
+ components:
+
+ ```
+ cd <gdk-dir>
+ gdk reconfigure
+ gdk update
+ ```
+
## 2016-10-31
- Add root check to catch root move problems. Requires gem 0.2.3 or
--
GitLab
From 19b2cb0d26239633ab005a74d2506131f9c6b41c Mon Sep 17 00:00:00 2001
From: Achilleas Pipinellis <axilleas@axilleas.me>
Date: Mon, 6 Feb 2017 17:05:39 +0100
Subject: [PATCH 2/2] Split info on GDK update and webpack troubleshooting
---
CHANGELOG.md | 37 +---------------
README.md | 1 +
doc/howto/troubleshooting.md | 82 ++++++++++++++++++++++++++++++++++--
doc/update-gdk.md | 21 +++++++++
4 files changed, 103 insertions(+), 38 deletions(-)
create mode 100644 doc/update-gdk.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 52d6fee..803793f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,41 +7,8 @@ features.
## 2017-02-01
- Add webpack process to Procfile configure it within gitlab.yml !237
-
- For existing GDK installations, manual action is required to update GDK.
- Assuming `origin` is the upstream repo, do the following:
-
- 1. First, update the CE/EE repo:
-
- ```
- cd <gitlab-ce-dir>
- git pull origin master
- bundle install && npm purge && npm install
- bundle exec rake webpack:compile
- ```
-
- 1. Pull the new GDK changes:
-
- ```
- cd <gdk-dir>
- git pull origin master
- ```
-
- 1. Make sure postgres is running:
-
- ```
- cd <gdk-dir>
- gdk run db
- ```
-
- 1. Then, **open a separate terminal window** and update GDK along with all its
- components:
-
- ```
- cd <gdk-dir>
- gdk reconfigure
- gdk update
- ```
+ Make sure to [update GDK](doc/update-gdk.md) and read the
+ [troubleshooting section](doc/howto/troubleshooting.md#webpack).
## 2016-10-31
diff --git a/README.md b/README.md
index a39bd8e..a59210b 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,7 @@ To start using GDK follow these three steps:
1. [Prepare your computer](doc/prepare.md)
2. [Install GDK](doc/set-up-gdk.md)
+4. [Update your existing GDK installation](doc/update-gdk.md)
3. [Learn how to use GDK](doc/howto/README.md)
## Design goals
diff --git a/doc/howto/troubleshooting.md b/doc/howto/troubleshooting.md
index 1b0ba90..6c7f303 100644
--- a/doc/howto/troubleshooting.md
+++ b/doc/howto/troubleshooting.md
@@ -247,8 +247,8 @@ deleted from the database.
## Foreman fails to start
-Foreman will fail to start if the `Thor` gem version installed is `0.19.3`
-(a foreman dependency), the stacktrace will be:
+Foreman will fail to start if the `Thor` gem version installed is `0.19.3`
+(a foreman dependency), the stacktrace will be:
```
gems/2.3.0/gems/thor-0.19.2/lib/thor/base.rb:534:in `thor_reserved_word?': "run" is a Thor reserved word and cannot be defined as command (RuntimeError)
@@ -262,12 +262,88 @@ gems/2.3.0/gems/thor-0.19.2/lib/thor/base.rb:534:in `thor_reserved_word?': "run"
from /.../bin/foreman:23:in `<main>'
```
-You can fix this by updating the `Thor` gem.
+You can fix this by updating the `Thor` gem.
```
gem update thor
```
+## Webpack
+
+Since webpack has been added as a new background process which gitlab depends on
+in development, the [GDK must be updated and reconfigured](../update-gdk.md) in
+order to work properly again.
+
+If you still encounter some errors, see the troubleshooting FAQ below:
+
+* I'm getting an error when I run `gdk reconfigure`:
+
+ ```
+ Makefile:30: recipe for target 'gitlab/config/gitlab.yml' failed
+ make: *** [gitlab/config/gitlab.yml] Error 1
+ ```
+
+ This is likely because you have not updated your gitlab CE/EE repository to
+ the latest master yet. It has a template for gitlab.yml in it which the GDK
+ needs to update. The `gdk update` step should have taken care of this for
+ you, but you can also manually go to your gitlab ce/ee directory and run
+ `git checkout master && git pull origin master`
+
+ ---
+
+* I'm getting an error when I attempt to access my local GitLab in a browser:
+
+ ```
+ Webpack::Rails::Manifest::ManifestLoadError at /
+ Could not load manifest from webpack-dev-server at http://localhost:3808/assets/webpack/manifest.json - is it running, and is stats-webpack-plugin loaded?
+ ```
+
+ or
+
+ ```
+ Webpack::Rails::Manifest::ManifestLoadError at /
+ Could not load compiled manifest from /path/to/gitlab-development-kit/gitlab/public/assets/webpack/manifest.json - have you run `rake webpack:compile`?
+ ```
+
+ This probably means that the webpack dev server isn't running or that your
+ gitlab.yml isn't properly configured. Ensure that you have run
+ `gdk reconfigure` **AND** that you have stopped and restarted any instance
+ of `gdk run` or `gdk run xxx` that was running prior to the reconfigure step
+
+ ---
+
+* I'm getting the following error when I try to run `gdk run` or `gdk run db`:
+
+ ```
+ 09:46:05 webpack.1 | npm ERR! argv "/usr/local/bin/node" "/usr/local/bin/npm" "run" "dev-server"
+ 09:46:05 webpack.1 | npm ERR! node v5.8.0
+ 09:46:05 webpack.1 | npm ERR! npm v3.10.7
+ 09:46:05 webpack.1 |
+ 09:46:05 webpack.1 | npm ERR! missing script: dev-server
+ ...
+ ```
+
+ This means your gitlab CE or EE instance is not running the current master
+ branch. If you are running a branch which hasn't been rebased on master
+ since Saturday, Feb 4th then you should rebase it on master. If you are
+ running the master branch, ensure it is up to date (`git pull`).
+
+ ---
+
+* I'm getting the following error when I try to run `gdk run` or `gdk run db`:
+
+ ```
+ 09:54:15 webpack.1 | > @ dev-server /Users/mike/Projects/gitlab-development-kit/gitlab
+ 09:54:15 webpack.1 | > webpack-dev-server --config config/webpack.config.js
+ 09:54:15 webpack.1 |
+ 09:54:15 webpack.1 | sh: webpack-dev-server: command not found
+ 09:54:15 webpack.1 |
+ ...
+ ```
+
+ This means you have not run `npm install` since updating your gitlab CE/EE
+ repository. The `gdk update` command should have done this for you, but you
+ can do so manually as well.
## Other problems
diff --git a/doc/update-gdk.md b/doc/update-gdk.md
new file mode 100644
index 0000000..476ca87
--- /dev/null
+++ b/doc/update-gdk.md
@@ -0,0 +1,21 @@
+# Updating GDK
+
+1. Make sure postgres is running:
+
+ ```
+ cd <gdk-dir>
+ gdk run db
+ ```
+
+1. Then, **open a separate terminal window** and update gdk along with all its
+ components:
+
+ ```
+ cd <gdk-dir>
+ git pull origin master
+ gdk update
+ gdk reconfigure
+ ```
+
+1. Then stop the `gdk run db` process running in the first tab. It must be
+ restarted once `gdk reconfigure` has been run.
--
GitLab