feat: dockerise tldr-lint #309
Merged
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
owenvoke
reviewed
Mar 21, 2024
Okay, I added a workflow that should push the image when a release is created. However, I have no idea how to test this. Do you have an idea how to test such things? |
Nice changes, I work with Docker and GHCR a lot. Will check out the workflow and get back. |
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
kbdharun
approved these changes
Mar 21, 2024
There was a problem hiding this comment.
LGTM, thanks for your contribution.
Regarding the changes I made,
- I updated the dependabot config for GitHub actions too.
- I changed the base Node version to an LTS one.
- I removed the QEMU action (as
linux/amdis the default GitHub runner) after testing I noticed the Node base image doesn't support other architectures (i.e.linux/arm,linux/riscv64) without performing other changes. - Added labels for the OCI image along with comments to the Dockerfile.
- Removed build and push action as it didn't support a compatible label/annotation to be shown in the package's metadata in GHCR (also it failed actions when executing with workflow dispatch). So IG we can use just a single tag 'latest' for ease of use. [With the current method the package metadata would look something like this.]
- Updated a few dependencies in
test.ymlfile and moved the Docker test code as a separate job under it alongside the build job.
|
Thank you so much for you efforts in improving this PR! |
owenvoke
reviewed
Mar 21, 2024
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
owenvoke
approved these changes
Mar 22, 2024
kbdharun
approved these changes
Mar 22, 2024
kbdharun
added a commit
that referenced
this pull request
Apr 3, 2024
* add tldr-lint dockerfile * Add docker build workflow * npm install -> npm ci * docker push workflow * fix docker publish wf syntax * insert missing tailing newline * tailing newline * improv: update Docker and CI files Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * cleanup: update CI files Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * improv: combine publish workflows Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * ci: add names for CI workflows --------- Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> Co-authored-by: Owen Voke <development@voke.dev>
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.
I was getting tired of having to install node in oder to run tldr-lint. I've thus written a Dockerfile which allows users to build a tldr-lint docker image.
I've added a workflow that builds the image in order to check whether or not the build process succeeds.
I've also added documentation in README.md.