From fb9c47933a514a4a02b13ffd25171c25641a1e94 Mon Sep 17 00:00:00 2001 From: Yves Brissaud Date: Thu, 10 Oct 2024 02:47:30 +0200 Subject: [PATCH] doc: update readme and examples Signed-off-by: Yves Brissaud --- README.md | 2 + examples/README.md | 36 + examples/alpine-hello.readme.md | 9 - examples/go/Dockerfile | 46 + examples/go/README.md | 36 + .../{alpine-hello.runx.yaml => go/runx.yaml} | 38 +- examples/golangci/README.md | 801 ++++++++++++++++++ examples/golangci/runx.yaml | 44 + examples/hello/README.md | 43 + examples/hello/runx.yaml | 20 + examples/with-defaults/README.md | 9 - examples/with-defaults/runx.yaml | 4 - 12 files changed, 1045 insertions(+), 43 deletions(-) create mode 100644 examples/README.md delete mode 100644 examples/alpine-hello.readme.md create mode 100644 examples/go/Dockerfile create mode 100644 examples/go/README.md rename examples/{alpine-hello.runx.yaml => go/runx.yaml} (71%) create mode 100644 examples/golangci/README.md create mode 100644 examples/golangci/runx.yaml create mode 100644 examples/hello/README.md create mode 100644 examples/hello/runx.yaml delete mode 100644 examples/with-defaults/README.md delete mode 100644 examples/with-defaults/runx.yaml diff --git a/README.md b/README.md index 5cdbe3d..b3c2ca2 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,8 @@ Or run the `hello` action: $ docker runx NAMESPACE/REPOSITORY hello ``` +See more examples in the [examples](/examples) directory. + ## CLI Plugin Installation ### Manual Installation diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..fba733b --- /dev/null +++ b/examples/README.md @@ -0,0 +1,36 @@ +# `docker runx` examples + +This directory contains examples used to decorate some images with `runx`. + +## Build + +### [hello](hello) + +``` +$ cd hello +$ docker runx decorate alpine -t NAMESPACE/hello +``` + +An already built image is available under `eunomie/runx-hello`. + +### [golangci](golangci) + +``` +$ cd golangci +$ docker runx decorate golangci/golangci-lint:latest -t NAMESPACE/golangci +``` + +An already built image is available under `eunomie/runx-golangci`. + +### [go](go) + +``` +$ cd go +$ docker runx decorate scratch -t NAMESPACE/go +``` + +An already built image is available under `eunomie/go`. + +## Usage + +Once you built your images, explore them using `--docs` and `--list` options. diff --git a/examples/alpine-hello.readme.md b/examples/alpine-hello.readme.md deleted file mode 100644 index a0d174c..0000000 --- a/examples/alpine-hello.readme.md +++ /dev/null @@ -1,9 +0,0 @@ -# Hello ! - -If you run this image, it will be a simple `alpine` image. - -If you run this image using `docker runx` and by specifying the `hello` action, it will display a message. - -```console -$ docker runx hello -``` diff --git a/examples/go/Dockerfile b/examples/go/Dockerfile new file mode 100644 index 0000000..acff615 --- /dev/null +++ b/examples/go/Dockerfile @@ -0,0 +1,46 @@ +# syntax=docker/dockerfile:1.4 + +ARG XX_VERSION=1.2.1 +ARG ALPINE_VERSION=3.20 +ARG GO_VERSION=1.23.1 + +ARG BIN_NAME + +FROM --platform=$BUILDPLATFORM tonistiigi/xx:${XX_VERSION} AS xx + +FROM --platform=$BUILDPLATFORM golang:${GO_VERSION}-alpine${ALPINE_VERSION} AS build-base +COPY --from=xx / / +RUN apk add --no-cache curl +RUN sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin +RUN apk add --no-cache git ca-certificates openssh-client + +FROM build-base AS build +ARG TARGETPLATFORM +RUN xx-go --wrap +WORKDIR /go/src/ +COPY go.mod ./ +COPY go.sum ./ +RUN --mount=type=ssh \ + --mount=type=cache,target=/root/.cache \ + --mount=type=cache,target=/go/pkg/mod \ + go mod download +COPY . ./ + +FROM build AS binary +ENV CGO_ENABLED=0 +ARG BIN_NAME +RUN --mount=type=cache,target=/root/.cache \ + --mount=type=cache,target=/go/pkg/mod \ + GIT_VERSION=$(git describe --tags | cut -c 2-) && \ + xx-go build \ + -o dist/${BIN_NAME} \ + -ldflags="-w -s \ + -X {{.PKG_NAME}}/internal/constants.Version=$GIT_VERSION" \ + ./cmd/${BIN_NAME} && \ + xx-verify dist/${BIN_NAME} + +FROM scratch AS export-bin +ARG BIN_NAME +ARG TARGETOS +ARG TARGETARCH +COPY --from=binary /go/src/dist/${BIN_NAME} /${BIN_NAME}-${TARGETOS}-${TARGETARCH} diff --git a/examples/go/README.md b/examples/go/README.md new file mode 100644 index 0000000..015dc66 --- /dev/null +++ b/examples/go/README.md @@ -0,0 +1,36 @@ +# Go tools - runx version + +This is a set of multiple tools to work with Go codebases. + +## Usage + +### Linter + +`lint` action will run `golangci-lint` on the codebase. + +Go packages and cache are shared with `golangci-lint` to speed up the process. + +### Build + +`build` action will build the codebase using `docker buildx` and output as (multi-platform) binaries. + +By convention if the binary name is `tool`, it will try to build `cmd/tool/` and the output will be inside `dist` directory. + +To make it more convenient while working on a code base, create a file `.docker/runx.yaml` with the following content: + +```yaml +ref: eunomie/go +images: + eunomie/go: + actions: + build: + opts: + bin_name: + platforms: +``` + +That way you will be able to run `docker runx build` without to specify anything else. + +### Mocks + +`mocks` action will generate mocks for the codebase using `mockery`. diff --git a/examples/alpine-hello.runx.yaml b/examples/go/runx.yaml similarity index 71% rename from examples/alpine-hello.runx.yaml rename to examples/go/runx.yaml index c1d7569..2722fa4 100644 --- a/examples/alpine-hello.runx.yaml +++ b/examples/go/runx.yaml @@ -1,25 +1,4 @@ -default: hello actions: - - id: hello:user - desc: Say hello to the current user - type: run - env: - - USER - shell: - uname: uname - cmd: --rm {{.Ref}} echo hello {{env "USER"}} from {{sh "uname"}} - - - id: hello - desc: Say hello! - type: run - opts: - - name: name - desc: User's name - prompt: Please enter your name - required: true - cmd: > - --rm {{.Ref}} echo hello {{opt "name"}} - - id: lint desc: Run golangci-lint type: run @@ -55,3 +34,20 @@ actions: --target export-bin --output type=local,dest=dist/ . + + - id: mocks + type: run + shell: + pwd: pwd + gopath: go env GOPATH + gocache: go env GOCACHE + cmd: > + --rm + -v {{sh "pwd"}}:/app + -v {{sh "gopath"}}/pkg:/go/pkg + -v {{sh "gocache"}}:/cache/go + -e GOCACHE=/cache/go + -v {{sh "pwd"}}:/src + -w /src + docker/mockery:v2.46 + --keeptree -r --all diff --git a/examples/golangci/README.md b/examples/golangci/README.md new file mode 100644 index 0000000..77a3838 --- /dev/null +++ b/examples/golangci/README.md @@ -0,0 +1,801 @@ +

+ golangci-lint logo +

golangci-lint

+

Fast linters runner for Go

+

+ +--- + +`golangci-lint` is a fast Go linters runner. + +It runs linters in parallel, uses caching, supports YAML configuration, +integrates with all major IDEs, and includes over a hundred linters. + +## Install `golangci-lint` + +- [On my machine](https://golangci-lint.run/welcome/install/#local-installation); +- [On CI/CD systems](https://golangci-lint.run/welcome/install/#ci-installation). + +## Documentation + +Documentation is hosted at https://golangci-lint.run. + +## Social Networks + +[![Join Slack](https://img.shields.io/badge/Slack-4285F4?logo=slack&logoColor=white)](https://gophers.slack.com/archives/CS0TBRKPC) +[![Follow on Mastodon](https://img.shields.io/badge/mastodon-6364FF?logo=mastodon&logoColor=white)](https://fosstodon.org/@golangcilint) +[![Follow on Twitter](https://img.shields.io/badge/twitter-1DA1F2?logo=twitter&logoColor=white)](https://twitter.com/golangci) + +## Supporting Us + +[![Open Collective backers and sponsors](https://img.shields.io/badge/OpenCollective-Donate-blue?logo=opencollective&style=for-the-badge)](https://opencollective.com/golangci-lint) +[![GitHub Sponsors](https://img.shields.io/badge/GitHub-Donate-blue?logo=github&style=for-the-badge)](https://github.com/sponsors/golangci) +[![Linter Authors](https://img.shields.io/badge/Linter_Authors-Donate-blue?style=for-the-badge)](https://golangci-lint.run/product/thanks/) + +`golangci-lint` is a free and open-source project built by volunteers. + +If you value it, consider supporting us, we appreciate it! :heart: + +## Badges + +![Build Status](https://github.com/golangci/golangci-lint/workflows/CI/badge.svg) +[![License](https://img.shields.io/github/license/golangci/golangci-lint)](/LICENSE) +[![Release](https://img.shields.io/github/release/golangci/golangci-lint.svg)](https://github.com/golangci/golangci-lint/releases/latest) +[![Docker](https://img.shields.io/docker/pulls/golangci/golangci-lint)](https://hub.docker.com/r/golangci/golangci-lint) +[![GitHub Releases Stats of golangci-lint](https://img.shields.io/github/downloads/golangci/golangci-lint/total.svg?logo=github)](https://somsubhra.github.io/github-release-stats/?username=golangci&repository=golangci-lint) + +## Contributors + +This project exists thanks to all the people who contribute. [How to contribute](https://golangci-lint.run/contributing/quick-start/). + + + + +### Core Team + +
+About core team + +The GolangCI Core Team is a group of contributors who have demonstrated a lasting enthusiasm for the project and community. +The GolangCI Core Team has GitHub admin privileges on the repo. + +#### Responsibilities + +The Core Team has the following responsibilities: + +1. Being available to answer high-level questions about vision and future. +2. Being available to review longstanding/forgotten pull requests. +3. Occasionally check issues, offer input, and categorize with GitHub issue labels. +4. Looking out for up-and-coming members of the GolangCI community who might want to serve as Core Team members. +5. Note that the Core Team – and all GolangCI contributors – are open-source volunteers; membership on the Core Team is expressly not an obligation. The Core Team is distinguished as leaders in the community and while they are a good group to turn to when someone needs an answer to a question, they are still volunteering their time, and may not be available to help immediately. + +
+ + + + + + + +

Ludovic Fernandez
Denis Isaev
Aleksandr Razumov
+ +### Team + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Simon Sawert
Sergey Vilgelm
Oleksandr Redko
Tam Mach
Trevor Pounds
Anton Telyshev
Loong Dai

Oleg Butuzov
Kamil Samigullin
Sascha Grunert
@iwankgb
Andrew Shannon Brown
Marat Reymers
sivchari

@leonklingele
Ryan Currah
Pierre Durand
Sebastien Rosset
Sasha Melentyev
Denis Tingaikin
Patrick Ohly

Alexey Palazhchenko
David Lobe
Ville Skyttä
Duco van Amstel
Nishanth Shanmugham
Kensei Nakada
ccoVeille

Melvin
quasilyte
Denis Krivak
Alec Thomas
Mitsuo HEIJO
Steve Coffman
Maik Schreiber
+ +
+And 509 more our team members + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Nahshon Unna Tsameret
Tom
Matouš Dzivjak
Nuruddin Ashr
Will Dixon
Mateusz Gozdek
Mateus Oliveira

Peter Mescalchin
Michael Mulligan
Joe Wilner
Soichiro Kashima
Lucas Bremgartner
@alingse
Steven Hartland

Oleg Kovalov
@silverwind
Florian Bosdorff
Kir Kolyshkin
Tim Heckman
James
Colin Arnott

Ethan Reesor
Anton Zinovyev
@Zxilly
Luke T. Shumaker
Aleksey Bakin
Márk Sági-Kazár
Rski

Ryan Boehning
Gustavo Bazan
Eugene Simonov
Timon Wong
ferhat elmas
Nate Finch
Aliaksandr Mianzhynski

Aneesh Agrawal
sonatard
Leigh McCulloch
Denis Limarev
ZhangYunHao
Vladimir Evgrafov
Ryosei Karaki

gaojingyu
@odidev
Fabian Holler
NiseVoid
Christian Mehlmauer
Sean DuBois
Viktoras Makauskas

SystemGlitch
Yifei Liu
Agniva De Sarker
Adam Shannon
Ilia Sergunin
Henrik Johansson
Florent Viel

Tom Arrell
Choko
John Starich
Koichi Shiraishi
Bart
Neha Viswanathan
David Braley

Sam Zaydel
Lukas Malkmus
Vladislav Fursov
Olivier Mengué
Shulhan
Chris Bandy
Patrick Kuca

Viacheslav Poturaev
Catena cyber
@Abirdcfly
Hendry Wiranto
Robert Liebowitz
Gabriel Augendre
Mitar

Paweł Żak
Zik Aeroh
sylvia
Roman Chaliy
Zeal Wierslee
Kyoh
Tim Kral

Hiroyuki Yagihashi
Denis Voytyuk
Jiangnan Jia
Adam Jones
Kunwardeep
Pierre R
Stephan Renatus

Martin Desrumaux
tdakkota
Ivan
Carlos Henrique Guardão Gandarez
Diego Pontoriero
Daniel Helfand
Benjamin Wang

Craig Silverstein
Faisal Alam
Alex Collins
Ryo Nakao
Ryan Olds
Matthew Hughes
Matheus Macabu

Tommy Mühle
Sebastiaan van Stijn
Hans Wernetti
Carlos Alexandro Becker
Dominik K.
Joshua Timmons
Sindre Røkenes Myren

Bartłomiej Klimczak
Fata Nugraha
M. Ángel Jimeno
Jan Oopkaup
Chris Drew
Teiva Harsanyi
Brian Flad

Chris Suszynski
Sean McGinnis
@chenfeining
Kailun Qin
Misha Gusarov
Ariel Mashraki
Oscar

Denis Isaev
Dreamacro
Tom Payne
@fsouza
jessetang
Siarhei Navatski
Chris Halbert

Koya IWAMURA
Hiroki Suezawa
Lauris BH
Fabrice
Christoph Blecker
Mateusz Bilski
Jakub Chábek

Ben Ye
Stephen Brown II
lufe
@sg0hsmt
Stephanie Wilde-Hobbs
Cory LaNou
Vitaly Isaev

Derek Perkins
Adam Bouqdib
Pete Wagner
Renato Suero
Clifton Kaznocha
Buyanov Vladimir
Sven Anderson

Ben Wells
Jonathan Chappelow
Yuki Okushi
hbc
WÁNG Xuěruì
@796RCP92VZ
Kévin Dunglas

Eric Wohltman
Borja Clemente
Mattias de Zalenski
@AlduLonghi
Justin Fuller
masibw
Navneeth Jayendran

Eduard Castany
Sonia Hamilton
@black-06
Gianguido Sorà
Oksana Grishchenko
Gareth Jones
Berezhnoy Pavel

proton
Son Luong Ngoc
Henry
Aofei Sheng
rnben
Maksym Pavlenko
Ivan Prisyazhnyy

@ngehrsitz
John Reese
Matthew Gabeler-Lee
Matthew Dowdell
James Lucktaylor
Masahiro Furudate
Dale Hui

Ondrej Fabry
Aris Tzoumas
Gabor Javorszky
hori-ryota
Kishan B
Eugene R.
Eric Jain

Ghvst Code
Markus
Sebastian Spaink
Andrew Lavery
Mark Fine
Rory Prendergast
Olli Raula

Tariq
Peter Štibraný
kaixiang zhong
@ced42
David Bariod
Stephen Benjamin
@kkHAIKE

Hsing-Yu (David) Chen
Batuhan Apaydın
Roman Gerasimov
Mostafa Moradian
@jkeys089
过客龙门
Eldar Rakhimberdin

Toon Schoenmakers
Cezar Sá Espinola
Ben Paxton
Connor Adams
Draven
David Cuadrado
Max Riveiro

Jeroen Demeyer
Mārtiņš Irbe
Yilong Li
Rodrigo Brito
@techknowlogick
takaya
Craig Furman

@ttys3
Michael Freeman
Mark Sart
Joshua Rubin
Danil Ovchinnikov
Rafael Franco
Ksenia Rogova

Paul Vaughan
Jared Allard
Glen Mailer
Ian Howell
Chris K
Grigory Zubankov
@xxpxxxxp

subham sarkar
Ryan Leung
Donal Byrne
@trajan0x
Yusuke Kadowaki
@CfirTsabari
Navneeth Jayendran

Marko
Chris Lewis
Muhammad Ikhsan
Anton Braer
Jaegoo Kim
David Gleich
@connorszczepaniak-wk

yuqengo
Dejan Benedik
Craig Rodrigues
Askari
Amir Hosseini
David Beitey
Brandur Leach

Dan Richelson
Denis Titusov
Daniil Pershin
Terdunov Vyacheslav
Sean Chittenden
Hui Zhu
@Harsimran1

rinsuki
Anton Antonov
@hn8
Kevin Gillette
Milas Bowman
@credativ-dar
Sean Lewis

☃ Elliot Shepherd
Nicolae Vartolomei
Martin Etmajer
Fisher Xu
Matthew Poer
Cody Ley-Han
@darklore

@to6ka
Wilkins
Collin Kreklow
Marcin Owsiany
C.J. Jameson
Jacek
paul fisher

@ofw
Rafik Draoui
Miles Delahunty
Anton Kachurin
Nico Ismaili
Benjamin Kane
Philip Linell

Herman van Zyl
Jongwoo Han
Yury Gargay
Jan Carreras
aimuz
Ryo Sato
Eric Zimanyi

Ben Bernays
Boban Acimovic
Tiago Peczenyj
Sean Trantalis
Viktor Alenkov
Eduardo Alves
Alex Bagnolini

Dima
David Hill
Troy Ronda
Andrey Grazhdankov
Ash McKenzie
K4YT3X
Florian Gessner

Osamu TONOMORI
Bo Liu
Steven Allen
Colin Arnott
Eran Levy
Roman Leventov
Hugo

Mathias Weber
Naveen
@maxsond
Maksim Meshkov
@raffepaffe
Abhinav Gupta
Michael

Evgeniy Kulikov
Chris Nesbitt-Smith
Daniel Caballero
Igor Zibarev
Carl Henderson
Shintaro Anazawa
Matt Braymer-Hayes

Arjen van der Ende
Pete Davison
Nanguan Lin
Devon Stewart
Silas Sewell
Tomas Dabašinskas
@xuri

Charl Matthee
Sriram Venkatesh
Peter Schuller
David Golub
Alexander Morozov
Pastoh
Liam White

Alex Dupre
Juanito
Jinming Yue
@wxdao
Sijie Yang
Stephen
Thang Minh Vu

Julia Ogris
Greg Curtis
@ac-rappi
Dudás Ádám
Abhishek | अभिषेक
Daniele
Takumasa Sakao

Ben Drucker
Matthew Cobbing
@Darlez
Kirill Danshin
mook
Kyungmin Bae
Dylan Arbour

Cory Miller
Ben Brown
Dor
sink
João Freitas
nick
David Bendory

@znley
Jonathan Colby
Justin Robertson
Caleb Xu
Tobias
Namco
Vasyl Haievyi

@andreykuchin
Irina
Petr Pučil
Aaron Bennett
zaunist
Egor Kovetskiy
Daniil Suvorov

Yuki Watanabe
Aisuko
Tung Leo
Kunal Singh
Rui Chen
Rez
Alexandre Vilain

Federico Guerinoni
Matias Lahti
Thirukumaran Vaseeharan
Alessio Treglia
Alay Patel
Linus Arver
Martin Hutchinson

Emanuel Bennici
Mayo
smantic
Sebastian Crane
Alexander Else
@vladopajic
@oxr463

Trim21
@eiffel-fl
@oliverpool
@Ak-Army
@humancalico
Christian Clauss
Johanan Liebermann

Korjavin Ivan
Eng Zer Jun
Mateus Esdras
Devin Gunay
Hilário Coelho
Thomas Cave
Selim Can CABA

Tibo Delor
@chainchad
Francois Parquet
Robert Kopaczewski
Marc Tudurí
@pohang
Cyrille Meichel

neglect-yp
Felix
Adrien
Joe Bergevin
Axetroy
Guillaume JG
Evan Cordell

靳灿奇
Nassos Kat
hitzhangjie
Jesse Donat
Oleg Shparber
Tomi Juntunen
Miel Donkers

Marccio Silva
Bastian
Tiago Silva
KADOTA, Kyohei
Conor Evans
Anirudh Sylendranath
@jumpeiMano

Alex Rodin
Oliver Gugger
Bryan Andrews
@TomerJLevy
Dmitry Titov
Thomas Gorham
Wei Jian Gan

Tamás Gulácsi
Jack Wilsdon
Michał Suchwałko
Alexander Apalikov
Domas Tamašauskas
Stéphane Chausson
neo_sli

@srdhoni
@derekhuizhang
takaokanbe
Sean Schneeweiss
pprzekwas
madflow
Arman Tarkhanian

John Adler
@licraft2019
@mlueckest
Malte Ehrlen
@golangaccount
Tyler Dorn
Enmanuel Moreira

Sylvain Rabot
Piotr Persona
Han Gyoung-Su
Harry Tennent
Kamyar Mirzavaziri
@w1ck3dg0ph3r
Richard Yuh

caption
Yi Song
guoguangwu
Artem K
R. Aidan Campbell
Mikhail Podtserkovskiy
oz

Erik Westra
Thomas Bonfort
Matthieu MOREL
Jared Szechy
Wilhelm Ågren
+ +
+ + + + + +## Stargazers over time + +[![Stargazers over time](https://starchart.cc/golangci/golangci-lint.svg)](https://starchart.cc/golangci/golangci-lint) \ No newline at end of file diff --git a/examples/golangci/runx.yaml b/examples/golangci/runx.yaml new file mode 100644 index 0000000..a674eba --- /dev/null +++ b/examples/golangci/runx.yaml @@ -0,0 +1,44 @@ +default: lint +actions: + - id: lint + desc: Run golangci-lint + type: run + shell: + pwd: pwd + gopath: go env GOPATH + gocache: go env GOCACHE + cmd: > + --rm + -v {{sh "pwd"}}:/app + -v {{sh "gopath"}}/pkg:/go/pkg + -v {{sh "gocache"}}:/cache/go + -e GOFLAGS=-buildvcs=false + -e GOCACHE=/cache/go + -e GOLANGCI_LINT_CACHE=/cache/go + -w /app + {{.Ref}} + golangci-lint run -v --timeout 5m + + - id: with-config + desc: Run golangci-lint with a specific config file + type: run + shell: + pwd: pwd + gopath: go env GOPATH + gocache: go env GOCACHE + opts: + - name: config + prompt: Please enter the path to the config file + required: true + cmd: > + --rm + -v {{sh "pwd"}}:/app + -v {{sh "gopath"}}/pkg:/go/pkg + -v {{sh "gocache"}}:/cache/go + --mount type=bind,source={{sh "pwd"}}/{{opt "config"}},target=/.golangci.yml + -e GOFLAGS=-buildvcs=false + -e GOCACHE=/cache/go + -e GOLANGCI_LINT_CACHE=/cache/go + -w /app + {{.Ref}} + golangci-lint run -v -c /.golangci.yml --timeout 5m diff --git a/examples/hello/README.md b/examples/hello/README.md new file mode 100644 index 0000000..fdd08e0 --- /dev/null +++ b/examples/hello/README.md @@ -0,0 +1,43 @@ +# docker runx - hello example + +This is a simple example of `docker runx` usage. + +The main idea is to use an `alpine` image and create two actions: +- one, `user` that will get the user name from the environment variable +- the other, `ask` that will ask the user for its name + +## Creation of the image + +This `README.md` file will be used as the documentation for the image. + +The [`runx.yaml`](runx.yaml) file contains the definition of the actions. + +``` +$ docker runx decorate alpine --tag NAMESPACE/REPOSITORY +``` + +## Usage + +### Print this file + +``` +$ docker runx NAMESPACE/REPOSITORY --docs +``` + +### Run the `user` action + +``` +$ docker runx NAMESPACE/REPOSITORY user +``` + +### Run the `ask` action + +``` +$ docker runx NAMESPACE/REPOSITORY ask +``` + +You can also provide the user name as an argument: + +``` +$ docker runx NAMESPACE/REPOSITORY ask --opt name=John +``` diff --git a/examples/hello/runx.yaml b/examples/hello/runx.yaml new file mode 100644 index 0000000..74fe6e1 --- /dev/null +++ b/examples/hello/runx.yaml @@ -0,0 +1,20 @@ +actions: + - id: user + desc: Say hello to the current user + type: run + env: + - USER + shell: + uname: uname + cmd: --rm {{.Ref}} echo hello {{env "USER"}} + + - id: ask + desc: Say hello! + type: run + opts: + - name: name + desc: User's name + prompt: Please enter your name + required: true + cmd: > + --rm {{.Ref}} echo hello {{opt "name"}} diff --git a/examples/with-defaults/README.md b/examples/with-defaults/README.md deleted file mode 100644 index a0d174c..0000000 --- a/examples/with-defaults/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# Hello ! - -If you run this image, it will be a simple `alpine` image. - -If you run this image using `docker runx` and by specifying the `hello` action, it will display a message. - -```console -$ docker runx hello -``` diff --git a/examples/with-defaults/runx.yaml b/examples/with-defaults/runx.yaml deleted file mode 100644 index 092ef54..0000000 --- a/examples/with-defaults/runx.yaml +++ /dev/null @@ -1,4 +0,0 @@ -actions: - - id: hello - type: run - cmd: --rm {{.Ref}} echo hello