Skip to content

Commit

Permalink
Add action to export definition
Browse files Browse the repository at this point in the history
  • Loading branch information
renatolond committed Nov 25, 2024
1 parent ca96113 commit 65bfb43
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 1 deletion.
37 changes: 37 additions & 0 deletions .github/workflows/api-docs.yml
Original file line number Diff line number Diff line change
@@ -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/[email protected]
with:
github_token: ${{ secrets.PAT_FOR_API_DOCS }}
message: "auto: Update swagger file for main"
repository: "retromeet/landing"
directory: "landing"
2 changes: 1 addition & 1 deletion app/api/base.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down

0 comments on commit 65bfb43

Please sign in to comment.