Merge pull request #101 from nimblehq/release/2.5.0

Author: hoangmirs

.eslintrc

@@ -1,6 +1,7 @@
 {
   "extends": [
-    "@nimblehq/eslint-config-nimble"
+    "@nimblehq/eslint-config-nimble",
+    "plugin:yml/recommended"
   ],
   "globals": {
     "I18n": true

.github/workflows/danger.yml

@@ -11,7 +11,6 @@ jobs:
     name: Run Danger
     runs-on: ubuntu-latest
     steps:
-
       - name: Checkout
         uses: actions/checkout@v3
         with:

.github/workflows/lint.yml

@@ -0,0 +1,31 @@
+name: Lint
+
+on: pull_request
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  docs_lint:
+    name: Run lint for API docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up node and restore cached dependencies
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18.x"
+          cache: yarn
+          cache-dependency-path: yarn.lock
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Generate API docs
+        run: yarn build:docs
+
+      - name: Run API docs linters
+        run: yarn lint:docs:public

.github/workflows/test.yml

@@ -1,6 +1,11 @@
 name: Test
 
-on: pull_request
+on:
+  pull_request:
+  push:
+    branches:
+      - develop
+      - main
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

.gitignore

@@ -49,3 +49,6 @@ yarn-debug.log*
 
 /app/assets/builds/*
 !/app/assets/builds/.keep
+
+# Add OpenAPI public file
+/public/openapi.yml

.spectral.yaml

@@ -0,0 +1,6 @@
+extends: ["spectral:oas"]
+
+rules:
+  oas3-unused-component: false
+  operation-operationId: false
+  info-contact: false

Dockerfile

@@ -103,7 +103,8 @@ RUN rm -rf tmp/docker
 
 # Compile assets
 RUN bundle exec rails i18n:js:export && \
-    bundle exec rails assets:precompile
+    bundle exec rails assets:precompile && \
+    yarn run build:docs
 
 EXPOSE $PORT
 

Gemfile.lock

@@ -244,6 +244,8 @@ GEM
       net-protocol
     nio4r (2.5.9)
     no_proxy_fix (0.1.2)
+    nokogiri (1.14.2-arm64-darwin)
+      racc (~> 1.4)
     nokogiri (1.14.2-x86_64-darwin)
       racc (~> 1.4)
     nokogiri (1.14.2-x86_64-linux)
@@ -448,6 +450,7 @@ GEM
     zeitwerk (2.6.7)
 
 PLATFORMS
+  arm64-darwin-22
   x86_64-darwin-22
   x86_64-linux
 

Makefile

@@ -12,6 +12,7 @@ env/start:
 
 env/setup:
 	make env/start
+	make doc/generate
 	rails db:setup
 	rails i18n:js:export
 
@@ -21,6 +22,9 @@ env/stop:
 env/teardown:
 	./bin/envteardown.sh
 
+doc/generate:
+	yarn run build:docs
+
 dev:
 	make env/start
 	./bin/dev.sh

app/controllers/api/docs/openapi_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module API
+  module Docs
+    class OpenapiController < ApplicationController
+      def show
+        render :show
+      end
+    end
+  end
+end