From 3911b5dc327ce17e87d0584dbcdd5f232f9a504e Mon Sep 17 00:00:00 2001 From: Valentin Reis Date: Thu, 20 Dec 2018 13:43:31 -0600 Subject: [PATCH] [doc] Readme update. --- .README.md | 18 +++++++----------- README.md | 14 ++++++-------- 2 files changed, 13 insertions(+), 19 deletions(-) diff --git a/.README.md b/.README.md index b5186ab..0120375 100644 --- a/.README.md +++ b/.README.md @@ -1,12 +1,9 @@ #### integration testing -This repository contains integration tests that validate the argo stack, -leveraging the 'argopkgs' repo +Integration tests that validate the argo stack, leveraging the 'argopkgs' repo. The intended usage is to override (some of) the source(s) with WIP -version(s), as part of development or continuous integration. This -gitlab CI snippets shows how to do this on a nix-enabled runner. Mind -that this setup tracks argotest master. +version(s), as part of development or continuous integration. ### Usage (tl;dr, I already have nix on my machine.) @@ -24,10 +21,10 @@ nix-shell -E ' ### Usage (in three parts) -- [*1*] Get Nix: `curl https://nixos.org/nix/install | sh` +- [**1**] Get Nix: `curl https://nixos.org/nix/install | sh` -- [*2*] Use the ~test~ attribute of the argotest' nix attribute set to enter a - test environment. For example, we can run default tests on the +- [**2**] Use the `test` attribute of the argotest' nix attribute set to enter a + test environment. For example, we can run default tests on the "argopkgs-pinned" version of argo components using: ```bash @@ -70,7 +67,7 @@ nix-shell -E '{ argotest ? (builtins.fetchGit { }).test' --run 'argotk.hs helloworld' ``` -- [3] The `test`environment contains the `argotk.hs` tool, which runs various +- [**3**] The `test`environment contains the `argotk.hs` tool, which runs various operations on the argo stack: Commands list: @@ -120,7 +117,6 @@ There are a few things one has to be aware of using this workflow: ### Example CI setup -For example, we could setup the CI for the `containers` repo like: ``` {.yml} integration.test: stage: test @@ -129,7 +125,7 @@ integration.test: url = https://xgitlab.cels.anl.gov/argo/argotest.git; ref="master";}) }: - (import argotest { containers-src = ./. ; }).test' + (import argotest { containers-src = ./. ; }).test' \ --run 'argotk.hs helloworld' artifacts: paths: diff --git a/README.md b/README.md index 2879a36..7e46a02 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,7 @@ This repository contains integration tests that validate the argo stack, leveraging the 'argopkgs' repo The intended usage is to override (some of) the source(s) with WIP -version(s), as part of development or continuous integration. This -gitlab CI snippets shows how to do this on a nix-enabled runner. Mind -that this setup tracks argotest master. +version(s), as part of development or continuous integration. ### Usage (tl;dr, I already have nix on my machine.) @@ -24,11 +22,11 @@ nix-shell -E ' ### Usage (in three parts) -- \[*1*\] Get Nix: `curl https://nixos.org/nix/install | sh` +- \[**1**\] Get Nix: `curl https://nixos.org/nix/install | sh` -- \[*2*\] Use the ~test~ attribute of the argotest' nix attribute set - to enter a test environment. For example, we can run default tests - on the "argopkgs-pinned" version of argo components using: +- \[**2**\] Use the `test` attribute of the argotest' nix attribute + set to enter a test environment. For example, we can run default + tests on the "argopkgs-pinned" version of argo components using: ``` {.bash} nix-shell -E ' @@ -70,7 +68,7 @@ nix-shell -E '{ argotest ? (builtins.fetchGit { }).test' --run 'argotk.hs helloworld' ``` -- \[3\] The `test`environment contains the `argotk.hs` tool, which +- \[**3**\] The `test`environment contains the `argotk.hs` tool, which runs various operations on the argo stack: Commands list: -- 2.26.2