This repository has been archived by the owner on Jun 4, 2024. It is now read-only.
Enable Swagger Documentation and Configure GitHub Workflow for Automatic Deployment to Docker Hub #1
Conversation
This file contains 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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Overview
This pull request introduces several key enhancements to our project. It focuses on enabling Swagger documentation for our API, setting up a GitHub Actions workflow for automatic deployment to Docker Hub, and a few additional improvements to streamline our development and deployment processes.
Changes Included:
Enable Swagger Documentation:
Integrated @nestjs/swagger to provide comprehensive API documentation.
Configured Swagger UI to be accessible at /, allowing developers to easily explore and understand the available endpoints and their specifications.
Added annotations to controllers and DTOs to ensure detailed and accurate API documentation.
GitHub Actions Workflow for Docker Deployment:
Added a GitHub Actions workflow file .github/workflows/docker-image.yml.
Configured the workflow to build and push Docker images to Docker Hub upon each push to the main branch.
Included steps to log in to Docker Hub, build the Docker image, and push it with appropriate tags.
Miscellaneous Improvements:
Updated the main application bootstrap file to integrate the Swagger setup with NetJS.
Ensured that all dependencies are properly versioned and aligned to avoid conflicts.
Enhanced logging configurations for better debugging and monitoring.