Skip to content

Commit 9fb53e0

Browse files
rafaelfrancarafaelfranca
authored
Merge pull request rails#43061 from edwinv/devcontainer
Github Codespaces configuration
2 parents 1a240cf + 539d41b commit 9fb53e0

File tree

4 files changed

+115
-0
lines changed

4 files changed

+115
-0
lines changed

‎.devcontainer/Dockerfile

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.191.1/containers/ruby/.devcontainer/base.Dockerfile
2+
3+
# [Choice] Ruby version: 3, 3.0, 2, 2.7, 2.6
4+
ARG VARIANT="3.0"
5+
FROM mcr.microsoft.com/vscode/devcontainers/ruby:0-${VARIANT}
6+
7+
# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
8+
ARG NODE_VERSION="none"
9+
RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
10+
11+
# [Optional] Uncomment this section to install additional OS packages.
12+
RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
13+
&& apt-get -y install --no-install-recommends \
14+
mariadb-server libmariadbclient-dev \
15+
postgresql postgresql-client postgresql-contrib libpq-dev \
16+
redis-server memcached \
17+
ffmpeg mupdf mupdf-tools libvips poppler-utils
18+
19+
20+
ARG IMAGEMAGICK_VERSION="7.1.0-5"
21+
RUN wget -qO /tmp/im.tar.xz https://imagemagick.org/download/releases/ImageMagick-$IMAGEMAGICK_VERSION.tar.xz \
22+
&& wget -qO /tmp/im.sig https://imagemagick.org/download/releases/ImageMagick-$IMAGEMAGICK_VERSION.tar.xz.asc \
23+
&& gpg --batch --keyserver keyserver.ubuntu.com --recv 89AB63D48277377A \
24+
&& gpg --batch --verify /tmp/im.sig /tmp/im.tar.xz \
25+
&& tar xJf /tmp/im.tar.xz -C /tmp \
26+
&& cd /tmp/ImageMagick-$IMAGEMAGICK_VERSION \
27+
&& ./configure --with-rsvg && make -j 9 && make install \
28+
&& ldconfig /usr/local/lib \
29+
&& rm -rf /tmp/*
30+
31+
32+
# [Optional] Uncomment this line to install additional gems.
33+
# Add the Rails main Gemfile and install the gems. This means the gem install can be done
34+
# during build instead of on start. When a fork or branch has different gems, we still have an
35+
# advantage due to caching of the other gems.
36+
RUN mkdir -p /tmp/rails
37+
COPY Gemfile Gemfile.lock RAILS_VERSION rails.gemspec package.json yarn.lock /tmp/rails/
38+
COPY actioncable/actioncable.gemspec /tmp/rails/actioncable/
39+
COPY actionmailbox/actionmailbox.gemspec /tmp/rails/actionmailbox/
40+
COPY actionmailer/actionmailer.gemspec /tmp/rails/actionmailer/
41+
COPY actionpack/actionpack.gemspec /tmp/rails/actionpack/
42+
COPY actiontext/actiontext.gemspec /tmp/rails/actiontext/
43+
COPY actionview/actionview.gemspec /tmp/rails/actionview/
44+
COPY activejob/activejob.gemspec /tmp/rails/activejob/
45+
COPY activemodel/activemodel.gemspec /tmp/rails/activemodel/
46+
COPY activerecord/activerecord.gemspec /tmp/rails/activerecord/
47+
COPY activestorage/activestorage.gemspec /tmp/rails/activestorage/
48+
COPY activesupport/activesupport.gemspec /tmp/rails/activesupport/
49+
COPY railties/railties.gemspec /tmp/rails/railties/
50+
RUN cd /tmp/rails \
51+
&& bundle install \
52+
&& yarn install \
53+
&& rm -rf /tmp/rails
54+
55+
# [Optional] Uncomment this line to install global node packages.
56+
# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

‎.devcontainer/boot.sh

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
bundle install
2+
yarn install
3+
4+
sudo service postgresql start
5+
sudo service mysql start
6+
sudo service redis-server start
7+
sudo service memcached start
8+
9+
# Create PostgreSQL users and databases
10+
sudo su postgres -c "createuser --superuser vscode"
11+
sudo su postgres -c "createdb -O vscode -E UTF8 -T template0 activerecord_unittest"
12+
sudo su postgres -c "createdb -O vscode -E UTF8 -T template0 activerecord_unittest2"
13+
14+
# Create MySQL database and databases
15+
MYSQL_PWD=root sudo mysql -uroot <<SQL
16+
CREATE USER 'rails'@'localhost';
17+
CREATE DATABASE activerecord_unittest DEFAULT CHARACTER SET utf8mb4;
18+
CREATE DATABASE activerecord_unittest2 DEFAULT CHARACTER SET utf8mb4;
19+
GRANT ALL PRIVILEGES ON activerecord_unittest.* to 'rails'@'localhost';
20+
GRANT ALL PRIVILEGES ON activerecord_unittest2.* to 'rails'@'localhost';
21+
GRANT ALL PRIVILEGES ON inexistent_activerecord_unittest.* to 'rails'@'localhost';
22+
SQL

‎.devcontainer/devcontainer.json

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
2+
// https://github.com/microsoft/vscode-dev-containers/tree/v0.191.1/containers/ruby
3+
{
4+
"name": "Ruby",
5+
"build": {
6+
"dockerfile": "Dockerfile",
7+
"context": "..",
8+
"args": {
9+
// Update 'VARIANT' to pick a Ruby version: 3, 3.0, 2, 2.7, 2.6
10+
"VARIANT": "3",
11+
// Options
12+
"NODE_VERSION": "lts/*"
13+
}
14+
},
15+
16+
// Set *default* container specific settings.json values on container create.
17+
"settings": {},
18+
19+
// Add the IDs of extensions you want installed when the container is created.
20+
"extensions": [
21+
"rebornix.Ruby"
22+
],
23+
24+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
25+
// "forwardPorts": [],
26+
27+
// Use 'postCreateCommand' to run commands after the container is created.
28+
"postCreateCommand": ".devcontainer/boot.sh",
29+
30+
// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
31+
"remoteUser": "vscode"
32+
33+
}

‎guides/source/contributing_to_ruby_on_rails.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,10 @@ Contributing to the Rails Code
187187

188188
To move on from submitting bugs to helping resolve existing issues or contributing your own code to Ruby on Rails, you _must_ be able to run its test suite. In this section of the guide, you'll learn how to set up the tests on your computer.
189189

190+
#### The Easiest Way
191+
192+
Start a Github Codespace from the repository and start developing right away from the browser IDE or in your local VScode. The Codespace is initialized with all required dependencies and allows you to run all tests.
193+
190194
#### The Easy Way
191195

192196
The easiest and recommended way to get a development environment ready to hack is to use the [rails-dev-box](https://github.com/rails/rails-dev-box).

0 commit comments

Comments
 (0)