Merge branch 'main' into feature/drop_sidekiq

Author: coorasse

README.md

@@ -39,6 +39,14 @@ We want you to know exactly the reason behind each single step of this guide.
 
 Thank you for your work and have fun! :tada:
 
+## Serving the Documentation Locally
+
+To view this documentation on your machine, run the following command:
+
+```sh
+mbook serve
+```
+
 ## License
 
 [Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode)

SUMMARY.md

@@ -46,7 +46,6 @@
     - [Sidekiq](ruby_on_rails/sidekiq.md)
     - [Cucumber](ruby_on_rails/cucumber.md)
     - [Amazon S3 and Cloudfront](ruby_on_rails/aws.md)
-    - [Carrierwave Upload](ruby_on_rails/carrierwave.md)
     - [Bootstrap](ruby_on_rails/bootstrap.md)
     - [FontAwesome](ruby_on_rails/font_awesome.md)
     - [Bullet](ruby_on_rails/bullet.md)

configure_git_repository.md

@@ -1,22 +1,35 @@
-# Configure the Git Repository
+# Configure the GitHub Repository
 
 These are the suggested configurations for our GitHub repositories.
 Please stick to it unless you have special needs.
 
-* Options
+* General Settings
   * Features: Remove *Wikis*, *Issues* and *Projects*
-  * Merge button: Automatically delete head branches
-  * Merge button: Remove *Allow merge commits* and *Allow rebase merging*
-  * Merge button: Allow auto-merge
+  * Pull Requests
+    * Disable *Allow merge commits* and *Allow rebase merging*
+    * Allow auto-merge
+    * Automatically delete head branches
+    * Always suggest updating pull request branches
 * Manage access
   * Add *staff* team as a collaborator with Admin access
   * Add *security* team as collaborator with Write access
 * Branches
-  * Default branch: `develop`. Click *update*
-  * Add these rules for the two branches `develop` and `main`:
-    * Require pull request reviews before merging
-    * Require status checks to pass before merging (after you configured the CI add it to the required checks)
-    * Always suggest updating pull request branches
+  * Default branch: either `main` or `develop` depending on whether you want one or two environments.
+* Rules/Rulesets
+  * `develop`
+    * Enforcement status: `Active`
+    * Branch targeting criteria: `develop`
+    * Bypass list: add `Repository Admin` Role with *allow for pull requests only* option
+    * Restrict deletions
+    * Require linear history
+    * Require a pull request before merging
+    * Require status checks to pass
+      * Select `ci/semaphore/push`
+    * Block force pushes
+  * `main` (same as develop but...)
+    * Branch targeting criteria: `main`
+    * ❌ Require a pull request before merging
+    * ❌ Require status checks to pass
 
 * Autolink references
   * Add a new Autolink reference with:

create_git_repository.md

@@ -12,7 +12,8 @@ Use the command `hub create -p renuo/[project-name]` to create the repo and add
 
 ## Public repos need a license
 
-If your repository is public, ensure that it contains a license. We usually use the [MIT](https://choosealicense.com/licenses/mit/) license if possible or a [CreativeCommons](https://creativecommons.org/licenses/) license for documentation-only repositories (such as the application setup guide 🙂).
+If your repository is public, ensure that it contains a license.
+We usually use the [MIT](https://choosealicense.com/licenses/mit/) license if possible or a [CreativeCommons](https://creativecommons.org/licenses/) license for documentation-only repositories (such as the application setup guide 🙂).
 You can add a license directly on GitHub while initializing a repository by selecting a license template in the "Add a license" dropdown.
 However, if the repository is already initialized, you're still able to add a license using a template:
 * Click `Create new file`

go_live.md

@@ -25,18 +25,24 @@ This is done via page rules in Cloudflare.
 1. Enter `https://www.example.com/$1`
 1. Click "Save and Deploy"
 
+## Deploio (Preferred Deployment Method)
+
+We now recommend deploying applications using [Deploio](https://deplo.io), moving away from Heroku.
+
+When preparing your app for production on Deploio, ensure the following:
+
+* Verify the machine type of the PostgreSQL database in the PostgreSQL resource view.
+* Confirm the configured application size in the application configuration tab.
+* Ensure the application replica count is correctly set in the application configuration tab.
+
+For detailed instructions and best practices, including quick start guides for a variety of frameworks, please refer to the [Deploio deployment documentation](https://docs.deplo.io/documentation/networking_and_deployment/).
+
 ## Heroku
 
 * Check the size and amount of dynos on Heroku
 * Check the database size plan on Heroku and upgrade if it is foreseeable that 10'000 rows are exceeded in a short time
 * Check additional addons and according plans on Heroku
 
-## Deploio
-
-* Verify the machine type of the PostgreSQL database in the PostgreSQL resource view
-* Confirm the configured application size in the application configuration tab
-* Ensure the application replica count is correctly set in the application configuration tab
-
 ## Other
 
 * Reset admin credentials, seeds, ... if necessary

ruby_on_rails/README.md

@@ -4,16 +4,22 @@ This setup will cover a pure, monolithic Rails Applications.
 This is the most frequent type of application we have at [Renuo](https://renuo.ch) and is probably also the easiest to setup.
 The application (and relative GitHub repo) will be named after the `[project-name]` you chose before.
 
-Have you chosen a `[project-name]` yet? If not, please do so now. Check our [Naming Conventions](../naming_conventions.md)
+> [!NOTE]
+> Have you chosen a `[project-name]` yet? If not, please do so now. Check our [Naming Conventions](../naming_conventions.md)
+
+> [!NOTE]
+> Have you decided if you need two environments (develop and main) or just one?
+> As a rule of thumb: for customers we always use two environments, for internal projects we usually only use one.
+> Why the difference? Because we can bare the risk of having a bug in an internal project, but we cannot do that for a customer.
+
 1. [Initialise the Rails Application](app_initialisation.md)
 1. [Push to Git Repository](first_git_push.md)
 1. [Initialise Gitflow](initialise_gitflow.md)
 1. [Configure Git Repository](../configure_git_repository.md)
-1. [Create an Application Server for Heroku](create_application_server_heroku.md)
-1. [Create an Application Server for Deploio](create_application_server_deploio.md)
+1. [Create an Application Server for Deploio](create_application_server_deploio.md) or [Create an Application Server for Heroku](create_application_server_heroku.md)
 1. [Configure the CI / CD](configure_ci.md)
 
-Once here, your app should be up and running on all three environments.
+Once here, your app should be up and running on all environments.
 
 It's now time to introduce some more tools which will help you and the team to keep a high quality during the project development.
 
@@ -56,14 +62,12 @@ useful services:
 1. [Devise](devise.md)
 1. [Cucumber](cucumber.md)
 1. [Amazon S3 and Cloudfront](aws.md)
-1. [Carrierwave Upload](carrierwave.md)
 1. awesome_print `gem 'awesome_print'`
 1. [bootstrap](bootstrap.md)
 1. [font-awesome](font_awesome.md)
 1. [bullet](bullet.md) `gem 'bullet'`
 1. [lograge](appsignal.md) `gem 'lograge'`
 1. Rack Tracker (Google Analytics) `gem 'rack-tracker'` --> see [Google Analytics](../google_analytics.md)
-1. [Typescript](https://github.com/typescript-ruby/typescript-rails)
 1. Favicons
 1. [Rack CORS](https://github.com/cyu/rack-cors)
 1. [Rack Attack](https://github.com/rack/rack-attack#installing)

ruby_on_rails/app_initialisation.md

@@ -65,32 +65,29 @@ Some other adjustments must be performed manually.
 
 Please perform these adjustments manually:
 
-#### ENV variables with Figaro
+#### ENV variables
 
-* Add `figaro` to Gemfile. Check the [gem homepage](https://github.com/laserlemon/figaro) to see how to install the gem
-(usually `bundle exec figaro install` is enough). Delete the newly created file `config/application.yml`...
-* and create `config/application.example.yml` where you will specify the only environment variable you need for now:
+* Add `dotenv-rails` to Gemfile. Check the [gem homepage](https://github.com/bkeepers/dotenv) to see how to install the gem.
+* and create `.env.example` in the root folder of the project where you will specify the only environment variable you need for now:
   `SECRET_KEY_BASE`.
-* Going forward we will only push the `config/application.example.yml` file to the repository in order to protect our env variables.
-* Add application.yml to .gitignore
-* Add the following section to your `bin/setup` script so that the `application.yml` is created from the `application.example.yml` when the project is setup locally:
+* Going forward we will only push the `.env.example` file to the repository in order to protect our env variables.
+* Add .env to .gitignore
+* Add the following section to your `bin/setup` script so that the `.env` is created from the `.env` when the project is setup locally:
 
   ```ruby
   puts "\n== Copying sample files =="
-  unless File.exist?('config/application.yml')
-    system! 'cp config/application.example.yml config/application.yml'
+  unless File.exist?('.env')
+    system! 'cp .env.example .env'
   end
   ```
 
-* add one more key to application.example.yml `APP_PORT: 3000`
+* add one more key to .env.example `APP_PORT=3000`
+* To ensure you have all the required keys from the `.env.example` in your `.env`,
+create the initializer for dotenv-rails in `config/initializers/dotenv_rails.rb`:
 
-  Make sure it comes **before** any `rails` comands.
-* To ensure you have all the required keys from the `application.example.yml` in your `application.yml`,
-create the initializer for figaro in `config/initializers/figaro.rb`:
-
-  ```ruby
-  Figaro.require_keys(YAML.load_file('config/application.example.yml').keys - %w[test production development])
-  ```
+```ruby
+Dotenv.require_keys(Dotenv.parse(".env.example").keys)
+```
 
 * Run `bin/setup` again.