feat: Add Docker support and automated image builds #6
Conversation
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
The application can now be run in an isolated Docker container.
A "Running with Docker" subsection has been added to the Usage section with command examples: - Building a Docker image - Basic container launch - Launching with additional parameters Now users can easily run an application in a Docker container without having to install dependencies on the system.
…hing Docker images. A `.github/workflows/docker.yml` file has been created that: - Automatically runs on pushes to main, v* tags, and pull requests - Builds a Docker image using Buildx - Automatically logs into the GitHub Container Registry - Generates tags for images based on: - Branch (for main) - PR number - Tag semver (v1.0.0 -> 1.0.0, 1.0) - Commit SHA - Uses caching to speed up builds - Publishes the image only on pushes (not on pull requests) Images are now automatically built and published to GHCR with every code change.
- Added 'latest' tag generation for pushes to main branch - Updated docker/metadata-action configuration with raw type tag - Tag 'latest' will now be published alongside other tags when pushing to main This ensures that the most recent stable build is always accessible with the 'latest' tag, improving developer experience and deployment workflows.
…image. In the "Running with Docker" section, a section has been added for using a pre-built image: - The pre-built image `ghcr.io/imperatormarsa/typr` is specified. - Added example commands for running the latest version. - Separated instructions into the recommended method (pre-built image) and building from source. Now users can run the application directly without having to build an image.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
This PR adds Docker support to simplify running the application and includes GitHub Actions for automated Docker image builds.
Fixes #5
Changes Proposed
Dockerfile- Containerizes the application for consistent execution.github/workflows/docker.yml)README.md- Added comprehensive Docker documentationDocker Features
docker pull ghcr.io/sakura-sx/typr:latestTesting
docker build -t app .docker run --rm app [args]Documentation
Notes