feat(ci): [BE-116] Add OpenAPI generation check and artifact upload#1862
Open
attyolu wants to merge 2 commits into
Open
feat(ci): [BE-116] Add OpenAPI generation check and artifact upload#1862attyolu wants to merge 2 commits into
attyolu wants to merge 2 commits into
Conversation
- Add BackEnd/scripts/generate-openapi.ts: headless NestJS bootstrap that
exports the full Swagger/OpenAPI JSON document without starting an HTTP
server or requiring real external services (DB, Redis, etc.). Environment
variable stubs are set inside the script and mirrored explicitly in CI so
the build is fully reproducible.
- Add 'openapi:generate' npm script to BackEnd/package.json (via ts-node +
tsconfig-paths so path aliases resolve correctly at script runtime).
- Update .github/workflows/backend-ci.yml:
* New 'openapi-check' job runs after dependency install:
1. Calls npm run openapi:generate to produce dist/openapi/openapi.json
2. Validates the spec (JSON syntax, 'openapi' field present, at least
one path) using a pure Python3 inline check (no extra deps).
3. Uploads the spec as a named artifact openapi-spec-<sha> with a
30-day retention, so reviewers can download it from any PR run.
* 'backend-ci-gate' now depends on both build-and-lint AND openapi-check,
failing the gate if either job does not succeed.
* CI summary table extended with the new OpenAPI Check row.
Closes EarnQuestOne#1143
|
@attyolu Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Contributor
|
Great job so far There are just two blockers — the workflow is failing and merge conflict. Could you take a look and fix it so all checks pass? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
##closes #1143
Add BackEnd/scripts/generate-openapi.ts: headless NestJS bootstrap that exports the full Swagger/OpenAPI JSON document without starting an HTTP server or requiring real external services (DB, Redis, etc.). Environment variable stubs are set inside the script and mirrored explicitly in CI so the build is fully reproducible.
Add 'openapi:generate' npm script to BackEnd/package.json (via ts-node + tsconfig-paths so path aliases resolve correctly at script runtime).
Update .github/workflows/backend-ci.yml:
Closes #1143
Linked Issue
Closes #
Description
What changed?
Why was it changed?
How was it implemented?
Type of Change
Contract Changelog Discipline
contracts/earn-quest/CHANGELOG.mdunder## [Unreleased]### Breaking Changesentry with impact, affected files, and migration stepstype(scope)!:) in the PR title or commit historyBREAKING CHANGE:explanation belowBREAKING CHANGE details (required for breaking contract changes):
Test Evidence
Unit Tests
npm run test)npm run test:cov)Test output / screenshot:
E2E / Integration Tests
npm run test:e2e)Endpoints tested:
GET/api/...Swagger / API Documentation
@ApiOperation,@ApiResponse, and@ApiBearerAuthdecorators@ApiProperty/@ApiPropertyOptional/api/docsand responses are accurateError Handling Checklist
HTTP Exceptions
NotFoundException,BadRequestException,ForbiddenException,UnauthorizedException,ConflictException, etc.)Errorthrown where an HTTP exception is expectedInput Validation (DTOs)
class-validatordecorators (@IsString,@IsUUID,@IsNotEmpty,@IsOptional, etc.)class-transformerdecorators applied where necessary (@Transform,@Type,@Expose)ValidationPipeis applied globally or at the controller level - raw unvalidated input is never usedGuards & Authorization
@UseGuards(JwtAuthGuard)or equivalent@Public()decorator where applicableLogging
LoggerService)errorlevel with stack tracesLoggerMiddleware- no duplicate logs addedStellar / Soroban Contract Interactions
Database / Migration
npm run typeorm:generate-migration)seed.ts)Breaking Type / Model Changes (Frontend — FE-068)
breaking-types☐breaking-runtime☐added☐changed☐deprecated☐removed☐fixed☐security## [Unreleased]inFrontEnd/my-app/CHANGELOG.mdOR a new file inFrontEnd/my-app/.changeset/.Migration:code block.cd FrontEnd/my-app && npm run changelog:checkpasses locally.changelog-skiplabel or[changelog-skip]to the PR title.Final Pre-Merge Checklist
main/masternpm run lint)npm run format)console.log/ debug statements left in production code.env.exampleupdated if new environment variables were introducedReadMe Backend.mdorReadMe Frontend.mdupdated if setup steps changedScreenshots / Recordings (if applicable)
Additional Notes for Reviewer