From 65bfb437b36e70f7a8b3fcf3ecd266f5dac4aaa9 Mon Sep 17 00:00:00 2001 From: "Renato \"Lond\" Cerqueira" Date: Mon, 25 Nov 2024 16:32:49 +0100 Subject: [PATCH] Add action to export definition --- .github/workflows/api-docs.yml | 37 ++++++++++++++++++++++++++++++++++ app/api/base.rb | 2 +- 2 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/api-docs.yml diff --git a/.github/workflows/api-docs.yml b/.github/workflows/api-docs.yml new file mode 100644 index 0000000..7202bcb --- /dev/null +++ b/.github/workflows/api-docs.yml @@ -0,0 +1,37 @@ +name: API Docs + +on: + push: + branches: [ export_openapi_definition ] + pull_request: + +jobs: + push: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + # Checkout the landing repository + - uses: actions/checkout@v4 + with: + repository: "retromeet/landing" + path: "landing" + + - name: Set up Ruby + # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby, + # change this to (see https://github.com/ruby/setup-ruby#versioning): + uses: ruby/setup-ruby@v1 + with: + bundler-cache: true # runs 'bundle install' and caches installed gems automatically + - name: Copy github env file + run: cp .env.github.test .env.test.local + - name: Run tests + run: bundle exec rake oapi:fetch > $GITHUB_WORKSPACE/landing/_data/openapi_main.json + - name: Commit & Push changes + uses: actions-js/push@v1.5 + with: + github_token: ${{ secrets.PAT_FOR_API_DOCS }} + message: "auto: Update swagger file for main" + repository: "retromeet/landing" + directory: "landing" diff --git a/app/api/base.rb b/app/api/base.rb index cb8e0f7..22894ad 100644 --- a/app/api/base.rb +++ b/app/api/base.rb @@ -32,7 +32,7 @@ class Base < Grape::API doc_version: RetroMeet::Version.to_s, info: { title: "RetroMeet API", - description: "This is the API that RetroMeet makes available for all apps that will use it.", + description: "This is the API that RetroMeet makes available for all apps that will use it!", license: "GNU Affero General Public License v3.0", license_url: "https://raw.githubusercontent.com/retromeet/core/refs/heads/main/LICENSE" },