Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
use OpenAPI jobs from workflows repo
Browse files Browse the repository at this point in the history
CubicrootXYZ committed Oct 13, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent edc8a5c commit 7761664
Showing 1 changed file with 15 additions and 32 deletions.
47 changes: 15 additions & 32 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -19,41 +19,24 @@ jobs:

golang_test:
uses: CubicrootXYZ/Workflows/.github/workflows/[email protected]
needs: [build_documentation] # Validates agains OpenAPI spec
needs: [build_openapi_spec] # Validates agains OpenAPI spec
with:
services: '{"database": {"image": "mysql:9.0", "ports": ["3306:3306"], "env": {"MYSQL_ROOT_PASSWORD": "mypass", "MYSQL_DATABASE": "remindme"}}}'
env: '{"TEST_DB_HOST": "database"}'

build_documentation:
runs-on: ubuntu-latest
if: "!startsWith(github.ref, 'refs/tags/')"
container:
image: cubicrootxyz/golang-ci:v1.23.0
options: --user root
steps:
- name: Checkout the repository
uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }}
- uses: actions/setup-node@v3
with:
node-version: "14"
- name: Get dependencies
run: go get ./...
- name: Build the api documentation
run: swag init --parseDependency=true -d . -g cmd/remindme/main.go
- name: Convert to OpenApi 3
run: openapi-code-sample-generator convert --file docs/swagger.yaml --output-file docs/swagger3.yaml
- name: Add code samples to api documentation
run: openapi-code-sample-generator generate --input-file docs/swagger3.yaml --output-file docs/api-spec.yaml
- name: Build static html
run: npx redoc-cli bundle docs/api-spec.yaml --output index.html
- name: Archive rendered HTML
uses: actions/upload-artifact@v4
with:
name: rendered-api-docu
path: |
index.html
build_openapi_spec:
uses: CubicrootXYZ/Workflows/.github/workflows/[email protected]
with:
entrypoint: cmd/remindme/main.go

render_openapi_spec:
needs:
- build_openapi_spec
uses: CubicrootXYZ/Workflows/.github/workflows/[email protected]
with:
spec_artifact_name: openapi-spec
spec_artifact_path: docs/
spec_filename: swagger.yaml

# publish_documentation:
# runs-on: ubuntu-latest
@@ -76,7 +59,7 @@ jobs:
# artifact_name: rendered-api-docu

build_and_push_image:
needs: [golang_test, golang_quality, build_documentation]
needs: [golang_test, golang_quality, render_openapi_spec]
runs-on: ubuntu-latest
if: "!startsWith(github.ref, 'refs/tags/')"
steps:

0 comments on commit 7761664

Please sign in to comment.