1
0
mirror of https://github.com/projekteuler/projekteuler.git synced 2026-01-27 02:28:50 +01:00

3 Commits

Author SHA1 Message Date
dependabot[bot]
10752d5344 Bump bootstrap from 5.2.3 to 5.3.2
Bumps [bootstrap](https://github.com/twbs/bootstrap-rubygem) from 5.2.3 to 5.3.2.
- [Release notes](https://github.com/twbs/bootstrap-rubygem/releases)
- [Changelog](https://github.com/twbs/bootstrap-rubygem/blob/main/CHANGELOG.md)
- [Commits](https://github.com/twbs/bootstrap-rubygem/compare/v5.2.3...v5.3.2)

---
updated-dependencies:
- dependency-name: bootstrap
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-10-30 15:29:06 +00:00
59c51f466a Merge pull request #350 from projekteuler/docker-build
Add Workflow for building and releasing Docker image
2023-08-19 22:07:00 +02:00
f014cffe41 Add Workflow for building and releasing Docker image 2023-08-18 15:55:33 +02:00
14 changed files with 242 additions and 34 deletions

39
.dockerignore Normal file
View File

@@ -0,0 +1,39 @@
# See https://docs.docker.com/engine/reference/builder/#dockerignore-file for more about ignoring files.
# Ignore git directory.
/.git/
# Ignore bundler config.
/.bundle
# Ignore all default key files.
/config/master.key
/config/credentials/*.key
# Ignore all environment files.
/.env*
!/.env.example
# Ignore all logfiles and tempfiles.
/log/*
/tmp/*
!/log/.keep
!/tmp/.keep
# Ignore pidfiles, but keep the directory.
/tmp/pids/*
!/tmp/pids/
!/tmp/pids/.keep
# Ignore storage (uploaded files in development and any SQLite databases).
/storage/*
!/storage/.keep
/tmp/storage/*
!/tmp/storage/
!/tmp/storage/.keep
# Ignore assets.
/node_modules/
/app/assets/builds/*
!/app/assets/builds/.keep
/public/assets

9
.gitattributes vendored Normal file
View File

@@ -0,0 +1,9 @@
# See https://git-scm.com/docs/gitattributes for more about git attribute files.
# Mark the database schema as having been generated.
db/schema.rb linguist-generated
# Mark any vendored files as having been vendored.
vendor/* linguist-vendored
config/credentials/*.yml.enc diff=rails_credentials
config/credentials.yml.enc diff=rails_credentials

View File

@@ -19,7 +19,7 @@ jobs:
- name: Set up Node - name: Set up Node
uses: actions/setup-node@v3 uses: actions/setup-node@v3
with: with:
node-version: "18" node-version: "20"
- name: Install dependencies - name: Install dependencies
run: bundle install --without production run: bundle install --without production
- name: Run tests - name: Run tests

48
.github/workflows/release.yml vendored Normal file
View File

@@ -0,0 +1,48 @@
#
name: Create and publish a Docker image
# Configures this workflow to run every time a change is pushed to the branch called `release`.
on:
push:
branches: ["release"]
# Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
# There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu.
jobs:
build-and-push-image:
runs-on: ubuntu-latest
# Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
permissions:
contents: read
packages: write
#
steps:
- name: Checkout repository
uses: actions/checkout@v3
# Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
- name: Log in to the Container registry
uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
# This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels.
- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
# This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages.
# It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
# It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
- name: Build and push Docker image
uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
with:
context: .
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}

23
.gitignore vendored
View File

@@ -12,13 +12,24 @@
/db/*.sqlite3-journal /db/*.sqlite3-journal
# Ignore all logfiles and tempfiles. # Ignore all logfiles and tempfiles.
/log/*.log /log/*
/tmp /tmp/*
!/log/.keep
!/tmp/.keep
# Ignore coverage data generated by coveralls # Ignore pidfiles, but keep the directory.
/coverage /tmp/pids/*
# Ignore encrypted secrets key file. !/tmp/pids/
config/secrets.yml.key !/tmp/pids/.keep
# Ignore storage (uploaded files in development and any SQLite databases).
/storage/*
!/storage/.keep
/tmp/storage/*
!/tmp/storage/
!/tmp/storage/.keep
/public/assets
# Ignore master key for decrypting credentials and more. # Ignore master key for decrypting credentials and more.
/config/master.key /config/master.key

1
.ruby-version Normal file
View File

@@ -0,0 +1 @@
ruby-3.2.2

77
Dockerfile Normal file
View File

@@ -0,0 +1,77 @@
# Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
ARG RUBY_VERSION=3.2.2
FROM registry.docker.com/library/ruby:$RUBY_VERSION-slim as base
# Rails app lives here
WORKDIR /rails
# Set production environment
ENV RAILS_ENV="production" \
BUNDLE_DEPLOYMENT="1" \
BUNDLE_PATH="/usr/local/bundle" \
BUNDLE_WITHOUT="development"
# Throw-away build stage to reduce size of final image
FROM base as build
# Install packages needed to build gems and node modules
RUN apt-get update -qq && \
apt-get install --no-install-recommends -y build-essential git libvips pkg-config curl node-gyp default-libmysqlclient-dev
# Install JavaScript dependencies
ARG NODE_VERSION=20.5.0
ARG YARN_VERSION=1.22.19
ENV PATH=/usr/local/node/bin:$PATH
RUN curl -sL https://github.com/nodenv/node-build/archive/master.tar.gz | tar xz -C /tmp/ && \
/tmp/node-build-master/bin/node-build "${NODE_VERSION}" /usr/local/node && \
npm install -g yarn@$YARN_VERSION && \
rm -rf /tmp/node-build-master
# Install application gems
COPY Gemfile Gemfile.lock ./
RUN bundle install && \
rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
bundle exec bootsnap precompile --gemfile
# Install node modules
#COPY package.json yarn.lock ./
#RUN yarn install --frozen-lockfile
# Copy application code
COPY . .
# Precompile bootsnap code for faster boot times
RUN bundle exec bootsnap precompile app/ lib/
# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
# Final stage for app image
FROM base
LABEL org.opencontainers.image.source=https://github.com/projekteuler/projekteuler
LABEL org.opencontainers.image.description="Projekteuler production image"
LABEL org.opencontainers.image.licenses=MIT
# Install packages needed for deployment
RUN apt-get update -qq && \
apt-get install --no-install-recommends -y curl node-gyp default-mysql-client libvips && \
rm -rf /var/lib/apt/lists /var/cache/apt/archives
# Copy built artifacts: gems, application
COPY --from=build /usr/local/bundle /usr/local/bundle
COPY --from=build /rails /rails
# Run and own only the runtime files as a non-root user for security
RUN useradd rails --create-home --shell /bin/bash && \
chown -R rails:rails db log tmp
USER rails:rails
# Entrypoint prepares the database.
ENTRYPOINT ["/rails/bin/docker-entrypoint"]
# Start the server by default, this can be overwritten at runtime
EXPOSE 3000
CMD ["./bin/rails", "server"]

View File

@@ -39,9 +39,9 @@ gem 'sdoc', '~> 2.6.1', group: :doc
gem 'web-console', '~> 4.2.0', group: :development gem 'web-console', '~> 4.2.0', group: :development
gem 'listen', '~> 3.8.0', group: :development gem 'listen', '~> 3.8.0', group: :development
gem 'bootstrap', '~> 5.2.3' gem 'bootstrap', '~> 5.3.2'
gem "bootstrap_form", "~> 5.2" gem "bootstrap_form", "~> 5.2"
gem 'font-awesome-sass', '~> 6.4.2' gem 'font-awesome-sass', '~> 6.4.0'
# Use Diffy for showing translation diffs # Use Diffy for showing translation diffs
gem 'diffy' gem 'diffy'

View File

@@ -68,16 +68,15 @@ GEM
tzinfo (~> 2.0) tzinfo (~> 2.0)
addressable (2.8.4) addressable (2.8.4)
public_suffix (>= 2.0.2, < 6.0) public_suffix (>= 2.0.2, < 6.0)
autoprefixer-rails (10.4.13.0) autoprefixer-rails (10.4.15.0)
execjs (~> 2) execjs (~> 2)
bcrypt (3.1.16) bcrypt (3.1.16)
bindex (0.8.1) bindex (0.8.1)
bootsnap (1.16.0) bootsnap (1.16.0)
msgpack (~> 1.2) msgpack (~> 1.2)
bootstrap (5.2.3) bootstrap (5.3.2)
autoprefixer-rails (>= 9.1.0) autoprefixer-rails (>= 9.1.0)
popper_js (>= 2.11.6, < 3) popper_js (>= 2.11.8, < 3)
sassc-rails (>= 2.0.0)
bootstrap_form (5.2.3) bootstrap_form (5.2.3)
actionpack (>= 6.0) actionpack (>= 6.0)
activemodel (>= 6.0) activemodel (>= 6.0)
@@ -103,13 +102,13 @@ GEM
diff-lcs (1.5.0) diff-lcs (1.5.0)
diffy (3.4.2) diffy (3.4.2)
erubi (1.12.0) erubi (1.12.0)
execjs (2.8.1) execjs (2.9.1)
faraday (2.7.4) faraday (2.7.4)
faraday-net_http (>= 2.0, < 3.1) faraday-net_http (>= 2.0, < 3.1)
ruby2_keywords (>= 0.0.4) ruby2_keywords (>= 0.0.4)
faraday-net_http (3.0.2) faraday-net_http (3.0.2)
ffi (1.15.5) ffi (1.16.3)
font-awesome-sass (6.4.2) font-awesome-sass (6.4.0)
sassc (~> 2.0) sassc (~> 2.0)
globalid (1.1.0) globalid (1.1.0)
activesupport (>= 5.0) activesupport (>= 5.0)
@@ -128,7 +127,7 @@ GEM
listen (3.8.0) listen (3.8.0)
rb-fsevent (~> 0.10, >= 0.10.3) rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10) rb-inotify (~> 0.9, >= 0.9.10)
loofah (2.21.3) loofah (2.21.4)
crass (~> 1.0.2) crass (~> 1.0.2)
nokogiri (>= 1.12.0) nokogiri (>= 1.12.0)
mail (2.8.1) mail (2.8.1)
@@ -139,8 +138,8 @@ GEM
marcel (1.0.2) marcel (1.0.2)
method_source (1.0.0) method_source (1.0.0)
mini_mime (1.1.2) mini_mime (1.1.2)
mini_portile2 (2.8.2) mini_portile2 (2.8.5)
minitest (5.18.1) minitest (5.20.0)
msgpack (1.6.0) msgpack (1.6.0)
multi_xml (0.6.0) multi_xml (0.6.0)
mysql2 (0.5.5) mysql2 (0.5.5)
@@ -154,7 +153,7 @@ GEM
net-smtp (0.3.3) net-smtp (0.3.3)
net-protocol net-protocol
nio4r (2.5.9) nio4r (2.5.9)
nokogiri (1.15.3) nokogiri (1.15.4)
mini_portile2 (~> 2.8.2) mini_portile2 (~> 2.8.2)
racc (~> 1.4) racc (~> 1.4)
oauth2 (2.0.9) oauth2 (2.0.9)
@@ -178,14 +177,14 @@ GEM
actionpack (>= 4.2) actionpack (>= 4.2)
omniauth (~> 2.0) omniauth (~> 2.0)
orm_adapter (0.5.0) orm_adapter (0.5.0)
popper_js (2.11.7) popper_js (2.11.8)
psych (5.1.0) psych (5.1.0)
stringio stringio
public_suffix (5.0.1) public_suffix (5.0.1)
puma (6.3.0) puma (6.3.0)
nio4r (~> 2.0) nio4r (~> 2.0)
racc (1.7.1) racc (1.7.1)
rack (2.2.7) rack (2.2.8)
rack-protection (3.0.6) rack-protection (3.0.6)
rack rack
rack-test (2.1.0) rack-test (2.1.0)
@@ -208,7 +207,7 @@ GEM
actionpack (>= 5.0.1.rc1) actionpack (>= 5.0.1.rc1)
actionview (>= 5.0.1.rc1) actionview (>= 5.0.1.rc1)
activesupport (>= 5.0.1.rc1) activesupport (>= 5.0.1.rc1)
rails-dom-testing (2.1.1) rails-dom-testing (2.2.0)
activesupport (>= 5.0.0) activesupport (>= 5.0.0)
minitest minitest
nokogiri (>= 1.6) nokogiri (>= 1.6)
@@ -225,7 +224,7 @@ GEM
rake (>= 12.2) rake (>= 12.2)
thor (~> 1.0) thor (~> 1.0)
zeitwerk (~> 2.5) zeitwerk (~> 2.5)
rake (13.0.6) rake (13.1.0)
rb-fsevent (0.11.2) rb-fsevent (0.11.2)
rb-inotify (0.10.1) rb-inotify (0.10.1)
ffi (~> 1.0) ffi (~> 1.0)
@@ -249,7 +248,7 @@ GEM
snaky_hash (2.0.1) snaky_hash (2.0.1)
hashie hashie
version_gem (~> 1.1, >= 1.1.1) version_gem (~> 1.1, >= 1.1.1)
sprockets (4.2.0) sprockets (4.2.1)
concurrent-ruby (~> 1.0) concurrent-ruby (~> 1.0)
rack (>= 2.2.4, < 4) rack (>= 2.2.4, < 4)
sprockets-rails (3.4.2) sprockets-rails (3.4.2)
@@ -259,8 +258,8 @@ GEM
sqlite3 (1.6.3) sqlite3 (1.6.3)
mini_portile2 (~> 2.8.0) mini_portile2 (~> 2.8.0)
stringio (3.0.6) stringio (3.0.6)
thor (1.2.2) thor (1.3.0)
tilt (2.1.0) tilt (2.3.0)
timeout (0.4.0) timeout (0.4.0)
turbolinks (5.2.1) turbolinks (5.2.1)
turbolinks-source (~> 5.2) turbolinks-source (~> 5.2)
@@ -287,20 +286,20 @@ GEM
will_paginate (3.3.1) will_paginate (3.3.1)
will_paginate-bootstrap4 (0.2.2) will_paginate-bootstrap4 (0.2.2)
will_paginate (~> 3.0, >= 3.0.0) will_paginate (~> 3.0, >= 3.0.0)
zeitwerk (2.6.8) zeitwerk (2.6.12)
PLATFORMS PLATFORMS
ruby ruby
DEPENDENCIES DEPENDENCIES
bootsnap bootsnap
bootstrap (~> 5.2.3) bootstrap (~> 5.3.2)
bootstrap_form (~> 5.2) bootstrap_form (~> 5.2)
coffee-rails (~> 5.0.0) coffee-rails (~> 5.0.0)
devise (~> 4.8.0) devise (~> 4.8.0)
diff-lcs diff-lcs
diffy diffy
font-awesome-sass (~> 6.4.2) font-awesome-sass (~> 6.4.0)
jbuilder (~> 2.11.3) jbuilder (~> 2.11.3)
jquery-rails (~> 4.5.1) jquery-rails (~> 4.5.1)
listen (~> 3.8.0) listen (~> 3.8.0)

View File

@@ -11,7 +11,7 @@ It allows visitors to view and suggest German translations of the maths puzzles
2. Make sure [NodeJS >= 18](https://nodejs.org) is installed. 2. Make sure [NodeJS >= 18](https://nodejs.org) is installed.
3. Navigate inside the repository folder. 3. Navigate inside the repository folder.
4. Use bundler to install all required gems. 4. Use bundler to install all required gems.
$ bundle install $ bundle install
5. Setup the database: 5. Setup the database:
$ bin/rails db:setup $ bin/rails db:setup
@@ -47,6 +47,8 @@ Do you want to implement this improvement yourself? Follow these steps:
- `DATABASE_NAME`: The name of the MySQL database - `DATABASE_NAME`: The name of the MySQL database
- `DATABASE_USERNAME`: The username for the MYSQL database - `DATABASE_USERNAME`: The username for the MYSQL database
- `DATABASE_PASSWORD`: The password for the MYSQL database - `DATABASE_PASSWORD`: The password for the MYSQL database
- `DATABASE_HOST`: The host of the MYSQL database
- `DATABASE_PORT`: The port of the MYSQL database
- `GITHUB_CLIENT_ID`: The client ID of your GitHub OAuth App (that you will need to create) - `GITHUB_CLIENT_ID`: The client ID of your GitHub OAuth App (that you will need to create)
- `GITHUB_CLIENT_SECRET`: The client secret of the GitHub OAuth App - `GITHUB_CLIENT_SECRET`: The client secret of the GitHub OAuth App
6. Install all required gems with `bundle install`. 6. Install all required gems with `bundle install`.

8
bin/docker-entrypoint Executable file
View File

@@ -0,0 +1,8 @@
#!/bin/bash -e
# If running the rails server then create or migrate existing database
if [ "${*}" == "./bin/rails server" ]; then
./bin/rails db:prepare
fi
exec "${@}"

View File

@@ -27,5 +27,5 @@ production:
database: <%= ENV['DATABASE_NAME'] %> database: <%= ENV['DATABASE_NAME'] %>
username: <%= ENV['DATABASE_USERNAME'] %> username: <%= ENV['DATABASE_USERNAME'] %>
password: <%= ENV['DATABASE_PASSWORD'] %> password: <%= ENV['DATABASE_PASSWORD'] %>
host: 127.0.0.1 host: <%= ENV['DATABASE_HOST'] %>
port: 3306 port: <%= ENV['DATABASE_PORT'] %>

View File

@@ -1,5 +1,19 @@
# Load the Rails application. # Load the Rails application.
require_relative "application" require_relative "application"
# Replace when upgrading to Rails 7.1
# See https://github.com/rails/rails/issues/32947#issuecomment-1356391185
class Rails::Application
def secret_key_base
if Rails.env.development? || Rails.env.test? || ENV["SECRET_KEY_BASE_DUMMY"]
secrets.secret_key_base ||= generate_development_secret
else
validate_secret_key_base(
ENV["SECRET_KEY_BASE"] || credentials.secret_key_base || secrets.secret_key_base
)
end
end
end
# Initialize the Rails application. # Initialize the Rails application.
Rails.application.initialize! Rails.application.initialize!

View File

@@ -18,7 +18,7 @@ Rails.application.configure do
# Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"] # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
# or in config/master.key. This key is used to decrypt credentials (and other encrypted files). # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
config.require_master_key = true config.require_master_key = false
# Disable serving static files from the `/public` folder by default since # Disable serving static files from the `/public` folder by default since
# Apache or NGINX already handles this. # Apache or NGINX already handles this.