From 38cb2b325aae7617d7ad5bf7579e86cdf72d7d0b Mon Sep 17 00:00:00 2001 From: thespad Date: Wed, 29 May 2024 15:34:12 +0100 Subject: [PATCH] Linting --- README.md | 31 +++++++++++++++++++++---------- readme-vars.yml | 31 +++++++++++++++++++++---------- 2 files changed, 42 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index f538722..bbd1327 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ The [LinuxServer.io](https://linuxserver.io) team brings you another container r * regular security updates Find us at: + * [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more! * [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team. * [Discourse](https://discourse.linuxserver.io) - post on our community forum. @@ -37,12 +38,11 @@ Find us at: [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/yq.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/yq) [![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-yq%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-yq/job/master/) - [yq](https://github.com/kislyuk/yq): Command-line YAML/XML processor - jq wrapper for YAML and XML documents. This image includes `yq`, `jq`, and `xq`. ## Supported Architectures -Our images support multiple architectures such as `x86-64` and `arm64` . We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). +Our images support multiple architectures such as `x86-64` and `arm64`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). Simply pulling `linuxserver/yq` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. @@ -58,7 +58,7 @@ The architectures supported by this image are: ### Docker cli -``` +```text docker run --rm \ -v "$PWD:$PWD" \ -w="$PWD" \ @@ -66,9 +66,10 @@ docker run --rm \ linuxserver/yq \ .foo.bar input.yml ``` + You can replace the last line with any yq command and argument, which will be passed to yq inside the image. -``` +```text docker run --rm \ -v "$PWD:$PWD" \ -w="$PWD" \ @@ -76,9 +77,10 @@ docker run --rm \ linuxserver/yq \ .foo.bar input.json ``` + You can replace the last line with any jq command and argument, which will be passed to jq inside the image. -``` +```text docker run --rm \ -v "$PWD:$PWD" \ -w="$PWD" \ @@ -86,30 +88,36 @@ docker run --rm \ linuxserver/yq \ .foo.bar input.xml ``` + You can replace the last line with any xq command and argument, which will be passed to xq inside the image. ### Recommended method We provide a very convenient script that allows the yq container to run as if it was installed natively: -``` + +```bash sudo curl -L --fail https://raw.githubusercontent.com/linuxserver/docker-yq/master/run-yq.sh -o /usr/local/bin/yq sudo chmod +x /usr/local/bin/yq ``` + Running these two commands on your docker host once will let you issue commands such as `yq .foo.bar input.yml` and the yq container will do its job behind the scenes. -``` +```bash sudo curl -L --fail https://raw.githubusercontent.com/linuxserver/docker-yq/master/run-jq.sh -o /usr/local/bin/jq sudo chmod +x /usr/local/bin/jq ``` + Running these two commands on your docker host once will let you issue commands such as `jq .foo.bar input.json` and the jq container will do its job behind the scenes. -``` +```bash sudo curl -L --fail https://raw.githubusercontent.com/linuxserver/docker-yq/master/run-xq.sh -o /usr/local/bin/xq sudo chmod +x /usr/local/bin/xq ``` + Running these two commands on your docker host once will let you issue commands such as `xq .foo.bar input.xml` and the xq container will do its job behind the scenes. ## Docker Mods + [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27yq%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=yq "view available mods for this container.") We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above. @@ -122,13 +130,15 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Updating Info ### Via Docker Cli + * Update the image: `docker pull linuxserver/yq` * You can also remove the old dangling images: `docker image prune` ## Building locally If you want to make local modifications to these images for development purposes or just to customize the logic: -``` + +```text git clone https://github.com/linuxserver/docker-yq.git cd docker-yq docker build \ @@ -138,7 +148,8 @@ docker build \ ``` The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static` -``` + +```text docker run --rm --privileged multiarch/qemu-user-static:register --reset ``` diff --git a/readme-vars.yml b/readme-vars.yml index 700dd9d..22ea7d5 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -22,6 +22,7 @@ full_custom_readme: | * regular security updates Find us at: + * [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more! * [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team. * [Discourse](https://discourse.linuxserver.io) - post on our community forum. @@ -41,12 +42,11 @@ full_custom_readme: | [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/yq.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/yq) [![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-yq%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-yq/job/master/) - [yq](https://github.com/kislyuk/yq): Command-line YAML/XML processor - jq wrapper for YAML and XML documents. This image includes `yq`, `jq`, and `xq`. ## Supported Architectures - Our images support multiple architectures such as `x86-64` and `arm64` . We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). + Our images support multiple architectures such as `x86-64` and `arm64`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). Simply pulling `linuxserver/yq` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. @@ -62,7 +62,7 @@ full_custom_readme: | ### Docker cli - ``` + ```text docker run --rm \ -v "$PWD:$PWD" \ -w="$PWD" \ @@ -70,9 +70,10 @@ full_custom_readme: | linuxserver/yq \ .foo.bar input.yml ``` + You can replace the last line with any yq command and argument, which will be passed to yq inside the image. - ``` + ```text docker run --rm \ -v "$PWD:$PWD" \ -w="$PWD" \ @@ -80,9 +81,10 @@ full_custom_readme: | linuxserver/yq \ .foo.bar input.json ``` + You can replace the last line with any jq command and argument, which will be passed to jq inside the image. - ``` + ```text docker run --rm \ -v "$PWD:$PWD" \ -w="$PWD" \ @@ -90,30 +92,36 @@ full_custom_readme: | linuxserver/yq \ .foo.bar input.xml ``` + You can replace the last line with any xq command and argument, which will be passed to xq inside the image. ### Recommended method We provide a very convenient script that allows the yq container to run as if it was installed natively: - ``` + + ```bash sudo curl -L --fail https://raw.githubusercontent.com/linuxserver/docker-yq/master/run-yq.sh -o /usr/local/bin/yq sudo chmod +x /usr/local/bin/yq ``` + Running these two commands on your docker host once will let you issue commands such as `yq .foo.bar input.yml` and the yq container will do its job behind the scenes. - ``` + ```bash sudo curl -L --fail https://raw.githubusercontent.com/linuxserver/docker-yq/master/run-jq.sh -o /usr/local/bin/jq sudo chmod +x /usr/local/bin/jq ``` + Running these two commands on your docker host once will let you issue commands such as `jq .foo.bar input.json` and the jq container will do its job behind the scenes. - ``` + ```bash sudo curl -L --fail https://raw.githubusercontent.com/linuxserver/docker-yq/master/run-xq.sh -o /usr/local/bin/xq sudo chmod +x /usr/local/bin/xq ``` + Running these two commands on your docker host once will let you issue commands such as `xq .foo.bar input.xml` and the xq container will do its job behind the scenes. ## Docker Mods + [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27yq%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=yq "view available mods for this container.") We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above. @@ -126,13 +134,15 @@ full_custom_readme: | ## Updating Info ### Via Docker Cli + * Update the image: `docker pull linuxserver/yq` * You can also remove the old dangling images: `docker image prune` ## Building locally If you want to make local modifications to these images for development purposes or just to customize the logic: - ``` + + ```text git clone https://github.com/linuxserver/docker-yq.git cd docker-yq docker build \ @@ -142,7 +152,8 @@ full_custom_readme: | ``` The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static` - ``` + + ```text docker run --rm --privileged multiarch/qemu-user-static:register --reset ```