Commit f2552696 authored by Clement Ho's avatar Clement Ho

Merge branch 'add-yarn-documentation' into 'master'

Update documentation to include yarn in our dependencies

See merge request !9316
parents 63cb6c84 c77b68d6
---
title: add rake tasks to handle yarn dependencies and update documentation
merge_request: 9316
author:
...@@ -155,15 +155,19 @@ page](https://golang.org/dl). ...@@ -155,15 +155,19 @@ page](https://golang.org/dl).
## 4. Node ## 4. Node
Since GitLab 8.17, GitLab requires the use of node >= v4.3.0 to compile Since GitLab 8.17, GitLab requires the use of node >= v4.3.0 to compile
javascript assets. In many distros the version provided by the official package javascript assets, and starting in GitLab 9.0, yarn >= v0.17.0 is required to
repositories is out of date, so we'll need to install through the following manage javascript dependencies. In many distros the versions provided by the
commands: official package repositories are out of date, so we'll need to install through
the following commands:
# install node v7.x # install node v7.x
curl --location https://deb.nodesource.com/setup_7.x | bash - curl --location https://deb.nodesource.com/setup_7.x | bash -
sudo apt-get install -y nodejs sudo apt-get install -y nodejs
Visit the official website for [node](https://nodejs.org/en/download/package-manager/) if you have any trouble with this step. # install yarn
curl --location https://yarnpkg.com/install.sh | bash -
Visit the official websites for [node](https://nodejs.org/en/download/package-manager/) and [yarn](https://yarnpkg.com/en/docs/install/) if you have any trouble with these steps.
## 5. System Users ## 5. System Users
...@@ -465,7 +469,7 @@ Check if GitLab and its environment are configured correctly: ...@@ -465,7 +469,7 @@ Check if GitLab and its environment are configured correctly:
### Compile Assets ### Compile Assets
sudo -u git -H npm install --production sudo -u git -H yarn install --production --pure-lockfile
sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production NODE_ENV=production sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production NODE_ENV=production
### Start Your GitLab Instance ### Start Your GitLab Instance
......
...@@ -60,15 +60,17 @@ module Gitlab ...@@ -60,15 +60,17 @@ module Gitlab
"Get latest code" => %W(#{Gitlab.config.git.bin_path} fetch), "Get latest code" => %W(#{Gitlab.config.git.bin_path} fetch),
"Switch to new version" => %W(#{Gitlab.config.git.bin_path} checkout v#{latest_version}), "Switch to new version" => %W(#{Gitlab.config.git.bin_path} checkout v#{latest_version}),
"Install gems" => %W(bundle), "Install gems" => %W(bundle),
"Install node modules" => %W(npm install --production),
"Migrate DB" => %W(bundle exec rake db:migrate), "Migrate DB" => %W(bundle exec rake db:migrate),
"Recompile assets" => %W(bundle exec rake gitlab:assets:clean gitlab:assets:compile), "Recompile assets" => %W(bundle exec rake yarn:install gitlab:assets:clean gitlab:assets:compile),
"Clear cache" => %W(bundle exec rake cache:clear) "Clear cache" => %W(bundle exec rake cache:clear)
} }
end end
def env def env
{ 'RAILS_ENV' => 'production' } {
'RAILS_ENV' => 'production',
'NODE_ENV' => 'production'
}
end end
def upgrade def upgrade
......
unless Rails.env.production? unless Rails.env.production?
desc "GitLab | Run ESLint" desc "GitLab | Run ESLint"
task :eslint do task eslint: ['yarn:check'] do
system("yarn", "run", "eslint") unless system('yarn run eslint')
abort('rake eslint failed')
end
end end
end end
namespace :gitlab do namespace :gitlab do
namespace :assets do namespace :assets do
desc 'GitLab | Assets | Compile all frontend assets' desc 'GitLab | Assets | Compile all frontend assets'
task :compile do task compile: [
Rake::Task['assets:precompile'].invoke 'yarn:check',
Rake::Task['webpack:compile'].invoke 'assets:precompile',
Rake::Task['gitlab:assets:fix_urls'].invoke 'webpack:compile',
end 'gitlab:assets:fix_urls'
]
desc 'GitLab | Assets | Clean up old compiled frontend assets' desc 'GitLab | Assets | Clean up old compiled frontend assets'
task :clean do task clean: ['assets:clean']
Rake::Task['assets:clean'].invoke
end
desc 'GitLab | Assets | Remove all compiled frontend assets' desc 'GitLab | Assets | Remove all compiled frontend assets'
task :purge do task purge: ['assets:clobber']
Rake::Task['assets:clobber'].invoke
end desc 'GitLab | Assets | Uninstall frontend dependencies'
task purge_modules: ['yarn:clobber']
desc 'GitLab | Assets | Fix all absolute url references in CSS' desc 'GitLab | Assets | Fix all absolute url references in CSS'
task :fix_urls do task :fix_urls do
......
unless Rails.env.production? unless Rails.env.production?
Rake::Task['karma'].clear if Rake::Task.task_defined?('karma')
namespace :karma do namespace :karma do
desc 'GitLab | Karma | Generate fixtures for JavaScript tests' desc 'GitLab | Karma | Generate fixtures for JavaScript tests'
RSpec::Core::RakeTask.new(:fixtures) do |t| RSpec::Core::RakeTask.new(:fixtures) do |t|
...@@ -10,7 +8,7 @@ unless Rails.env.production? ...@@ -10,7 +8,7 @@ unless Rails.env.production?
end end
desc 'GitLab | Karma | Run JavaScript tests' desc 'GitLab | Karma | Run JavaScript tests'
task :tests do task tests: ['yarn:check'] do
sh "yarn run karma" do |ok, res| sh "yarn run karma" do |ok, res|
abort('rake karma:tests failed') unless ok abort('rake karma:tests failed') unless ok
end end
...@@ -18,8 +16,5 @@ unless Rails.env.production? ...@@ -18,8 +16,5 @@ unless Rails.env.production?
end end
desc 'GitLab | Karma | Shortcut for karma:fixtures and karma:tests' desc 'GitLab | Karma | Shortcut for karma:fixtures and karma:tests'
task :karma do task karma: ['karma:fixtures', 'karma:tests']
Rake::Task['karma:fixtures'].invoke
Rake::Task['karma:tests'].invoke
end
end end
namespace :yarn do
desc 'Ensure Yarn is installed'
task :available do
unless system('yarn --version', out: File::NULL)
warn(
'Error: Yarn executable was not detected in the system.'.color(:red),
'Download Yarn at https://yarnpkg.com/en/docs/install'.color(:green)
)
abort
end
end
desc 'Ensure Node dependencies are installed'
task check: ['yarn:available'] do
unless system('yarn check --ignore-engines', out: File::NULL)
warn(
'Error: You have unmet dependencies. (`yarn check` command failed)'.color(:red),
'Run `yarn install` to install missing modules.'.color(:green)
)
abort
end
end
desc 'Install Node dependencies with Yarn'
task install: ['yarn:available'] do
unless system('yarn install --pure-lockfile --ignore-engines')
abort 'Error: Unable to install node modules.'.color(:red)
end
end
desc 'Remove Node dependencies'
task :clobber do
warn 'Purging ./node_modules directory'.color(:red)
FileUtils.rm_rf 'node_modules'
end
end
desc 'Install Node dependencies with Yarn'
task yarn: ['yarn:install']
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment