initial project creation

.github/workflows/_update_terraform.yml

@@ -0,0 +1,60 @@
+name: Update Terraform
+on:
+  workflow_call:
+    secrets:
+      PERSONAL_ACCESS_TOKEN:
+        required: true
+    inputs:
+      image_tag:
+        description: Tag for the image for docker/ghcr registries
+        required: true
+        type: string
+      deployment_environment:
+        description: The terraform target environment
+        required: true
+        type: string
+        default: staging
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    env:
+      GIT_SHA: ${{ github.sha }}
+      GIT_TAG: ${{ inputs.image_tag }}
+    steps:
+      - name: Checkout terraform config repo
+        uses: actions/checkout@v4
+        with:
+          # public repo with terraform configuration
+          repository: "datacite/mastino"
+          persist-credentials: false
+      - name: Setup dokerize and template parameters
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          wget https://github.com/jwilder/dockerize/releases/download/v0.6.0/dockerize-linux-amd64-v0.6.0.tar.gz
+          tar -xzvf dockerize-linux-amd64-v0.6.0.tar.gz
+          rm dockerize-linux-amd64-v0.6.0.tar.gz
+
+      - name: Conditionally update staging environment
+        if: ${{ (inputs.deployment_environment == 'staging') }}
+        run: |
+          ./dockerize -template stage/services/client-api/_events.auto.tfvars.tmpl:stage/services/client-api/_events.auto.tfvars
+          git add stage/services/client-api/_events.auto.tfvars
+          git commit -m "Adding events git variables for commit ${{ github.sha }}"
+
+      - name: Conditionally update production/test environments
+        if: ${{ (inputs.deployment_environment == 'production') }}
+        run: |
+          ./dockerize -template prod-eu-west/services/client-api/_events.auto.tfvars.tmpl:prod-eu-west/services/client-api/_events.auto.tfvars
+          ./dockerize -template test/services/client-api/_events.auto.tfvars.tmpl:test/services/client-api/_events.auto.tfvars
+
+          git add prod-eu-west/services/client-api/_events.auto.tfvars
+          git add test/services/client-api/_events.auto.tfvars
+          git commit -m "Adding events git variables for tag ${{ inputs.image_tag }}"
+      - name: Push changes
+        uses: ad-m/github-push-action@v0.8.0
+        with:
+          github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+          repository: "datacite/mastino"
+          branch: "refs/heads/master"
+          tags: false

.github/workflows/branch_to_staging.yml

@@ -0,0 +1,23 @@
+name: Build/Deploy Branch to Staging
+on:
+  workflow_dispatch:
+jobs:
+  lint:
+    uses: ./.github/workflows/rubocop.yml
+  test:
+    uses: ./.github/workflows/parallel_ci.yml
+    secrets: inherit
+  call_build_and_push:
+    needs: test
+    uses: ./.github/workflows/build.yml
+    with:
+      image_name: ${{ github.repository }}
+      image_tag: ${{ github.ref_name }}
+    secrets: inherit
+  deploy:
+    needs: [test, call_build_and_push]
+    uses: ./.github/workflows/_update_terraform.yml
+    with:
+      image_tag: ${{ github.ref_name }}
+      deployment_environment: staging
+    secrets: inherit

.github/workflows/build.yml

@@ -0,0 +1,54 @@
+name: Build and Tag
+on:
+  workflow_call:
+    secrets:
+      DOCKERHUB_USERNAME:
+        required: true
+      DOCKERHUB_TOKEN:
+        required: true
+    inputs:
+      image_name:
+        description: The name of the image for docker/ghcr registries
+        required: true
+        type: string
+      image_tag:
+        description: Tag for the image for docker/ghcr registries
+        required: true
+        type: string
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Cache Docker layers
+        uses: actions/cache@v4
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+      - name: Login to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build and Push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: |
+            ${{ inputs.image_name }}:${{ inputs.image_tag }}
+            ghcr.io/${{ inputs.image_name }}:${{ inputs.image_tag }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache

.github/workflows/deploy.yml

@@ -0,0 +1,25 @@
+name: Deploy Main to Staging
+on:
+  push:
+    branches:
+      - main
+jobs:
+  lint:
+    uses: ./.github/workflows/rubocop.yml
+  test:
+    uses: ./.github/workflows/parallel_ci.yml
+    secrets: inherit
+  call_build_and_push:
+    needs: test
+    uses: ./.github/workflows/build.yml
+    with:
+      image_name: ${{ github.repository }}
+      image_tag: main
+    secrets: inherit
+  deploy:
+    needs: [test, call_build_and_push]
+    uses: ./.github/workflows/_update_terraform.yml
+    with:
+      image_tag: main
+      deployment_environment: staging
+    secrets: inherit

.github/workflows/parallel_ci.yml

@@ -0,0 +1,32 @@
+name: Parallel CI
+on:
+  workflow_call:
+jobs:
+  parallel-test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+    services:
+      memcached:
+        image: memcached:1.4.31
+        ports:
+          - 11211/udp
+    env:
+      LOG_LEVEL: "error"
+      MYSQL_HOST: "127.0.0.1"
+      MYSQL_DATABASE: datacite
+      MYSQL_USER: root
+      ES_HOST: "localhost:9200"
+      ELASTIC_PASSWORD: "AnUnsecurePassword123"
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: Set up Ruby 3.1.6
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.1.6"
+          bundler-cache: true
+
+      - name: Run Specs
+        run: bundle exec rspec

.github/workflows/pull_request.yml

@@ -0,0 +1,13 @@
+name: Lint and Test Pull Request
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+jobs:
+  lint:
+    uses: ./.github/workflows/rubocop.yml
+  parallel-test:
+    needs: lint
+    uses: ./.github/workflows/parallel_ci.yml
+    secrets: inherit

.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Release to Production
+on:
+  release:
+    types: [published]
+jobs:
+  lint:
+    uses: ./.github/workflows/rubocop.yml
+  test:
+    uses: ./.github/workflows/parallel_ci.yml
+    secrets: inherit
+  call_build_and_push:
+    needs: test
+    uses: ./.github/workflows/build.yml
+    with:
+      image_name: ${{ github.repository }}
+      image_tag: ${{ github.ref_name }}
+    secrets: inherit
+  deploy:
+    needs: [test, call_build_and_push]
+    uses: ./.github/workflows/_update_terraform.yml
+    with:
+      image_tag: ${{ github.ref_name }}
+      deployment_environment: production
+    secrets: inherit

.github/workflows/rubocop.yml

@@ -0,0 +1,29 @@
+name: RuboCop
+
+on:
+  workflow_call:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby 3.0
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.6
+      - name: Cache gems
+        uses: actions/cache@v4
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-rubocop-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-rubocop-
+      - name: Install gems
+        run: |
+          bundle config path vendor/bundle
+          bundle config set without 'default doc job cable storage ujs test db'
+          bundle install --jobs 4 --retry 3
+      - name: Run RuboCop
+        run: bundle exec rubocop --parallel

.gitignore

@@ -0,0 +1,58 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+.byebug_history
+.DS_Store
+.svn
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/.capistrano
+/vendor/node_modules/*
+/vendor/bower_components/*
+/vendor/npm-debug.log
+/vendor/bundle/*
+/log/*
+/tmp/*
+/data/*
+/db/*.sqlite3
+/public/*
+!/public/.keep
+/coverage/
+/spec/tmp/
+/config/data_bags/*
+**.orig
+rerun.txt
+pickle-email-*.html
+.idea/*
+erl_crash.dump
+optimise-db.txt
+doc/dependencies*
+.env
+.env.*
+!.env.example
+!.env.travis
+!.env.build
+docker-compose.override.yml
+.vscode
+.solargraph.yml
+.devspace

.rubocop.yml

@@ -0,0 +1,31 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+plugins:
+  - rubocop-performance
+  - rubocop-rails
+  - rubocop-rspec
+
+require:
+  - rubocop-factory_bot
+
+AllCops:
+  TargetRubyVersion: 3.0
+  Exclude:
+    - "bin/**/*"
+    - "log/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+    - "db/schema.rb"
+
+Style/MethodCallWithArgsParentheses:
+  EnforcedStyle: require_parentheses
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true