From e4a06868f3ea4269f9137bbf68996d794847a8d8 Mon Sep 17 00:00:00 2001 From: Benedikt Haas Date: Wed, 20 Dec 2023 13:26:34 +0100 Subject: [PATCH 1/5] allow toggling of checkout action and its lfs support --- action.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/action.yml b/action.yml index ad69ea9..4374258 100644 --- a/action.yml +++ b/action.yml @@ -116,6 +116,14 @@ inputs: description: "Push images with tag `latest`/`latest-dev` in addition to the configured image names" default: false + enable-checkout: + description: "Enable checkout of repository prior to running the pipeline" + default: true + + enable-checkout-lfs: + description: "Enable download of lfs files for the repository checkout" + default: true + runs: using: "composite" From 8d6ec1821f17d0d3e4f08a53c4eb60e8a2b451c8 Mon Sep 17 00:00:00 2001 From: Benedikt Haas Date: Wed, 20 Dec 2023 13:27:28 +0100 Subject: [PATCH 2/5] add new options to readme --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index d74cca6..8333196 100644 --- a/README.md +++ b/README.md @@ -362,6 +362,12 @@ Create a folder `additional-files` in your `docker` folder (or configure a diffe - **`-` | `DOCKER_ROS_GIT_REF`** Git reference of *docker-ros* to run in CI *default:* `main` +- **`enable-checkout` | `( - )`** + Enable [*checkout*](https://github.com/actions/checkout) action to (re-)download your repository prior to running the pipeline + *default:* `true` +- **`enable-checkout-lfs` | `( - )`** + Enable [*git-lfs*](https://git-lfs.com/) support for the [*checkout*](https://github.com/actions/checkout) action + *default:* `true` - **`enable-industrial-ci` | `ENABLE_INDUSTRIAL_CI`** Enable [*industrial_ci*](https://github.com/ros-industrial/industrial_ci) *default:* `false` From 5487d6f901c1ec47c5cd4b7c4a55dc9dc95f7902 Mon Sep 17 00:00:00 2001 From: Benedikt Haas Date: Wed, 20 Dec 2023 14:25:56 +0100 Subject: [PATCH 3/5] use toggle inputs in checkout step --- action.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/action.yml b/action.yml index 4374258..f8e4761 100644 --- a/action.yml +++ b/action.yml @@ -131,9 +131,10 @@ runs: - name: Checkout repository uses: actions/checkout@v3 + if: ${{ inputs.enable-checkout == 'true' }} with: submodules: true - lfs: true + lfs: ${{ enable-checkout-lfs }} - name: Set up docker-ros shell: bash From 5a7f5d7841dfd7eb3602a11ea5cadd59c543358a Mon Sep 17 00:00:00 2001 From: Benedikt Haas Date: Wed, 20 Dec 2023 14:29:37 +0100 Subject: [PATCH 4/5] small input fix --- action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/action.yml b/action.yml index f8e4761..ebf032c 100644 --- a/action.yml +++ b/action.yml @@ -134,7 +134,7 @@ runs: if: ${{ inputs.enable-checkout == 'true' }} with: submodules: true - lfs: ${{ enable-checkout-lfs }} + lfs: ${{ inputs.enable-checkout-lfs }} - name: Set up docker-ros shell: bash From 03440a7424a3b2fb17b0a0eed690a6421999301a Mon Sep 17 00:00:00 2001 From: Lennart Reiher Date: Wed, 17 Jan 2024 09:42:57 +0100 Subject: [PATCH 5/5] improve doc of new config params --- README.md | 8 ++++---- action.yml | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8333196..82f5b40 100644 --- a/README.md +++ b/README.md @@ -362,11 +362,11 @@ Create a folder `additional-files` in your `docker` folder (or configure a diffe - **`-` | `DOCKER_ROS_GIT_REF`** Git reference of *docker-ros* to run in CI *default:* `main` -- **`enable-checkout` | `( - )`** - Enable [*checkout*](https://github.com/actions/checkout) action to (re-)download your repository prior to running the pipeline +- **`enable-checkout` | `-`** + Enable [*checkout*](https://github.com/actions/checkout) action to (re-)download your repository prior to running the pipeline *default:* `true` -- **`enable-checkout-lfs` | `( - )`** - Enable [*git-lfs*](https://git-lfs.com/) support for the [*checkout*](https://github.com/actions/checkout) action +- **`enable-checkout-lfs` | `-`** + Enable [*git-lfs*](https://git-lfs.com/) support for the [*checkout*](https://github.com/actions/checkout) action *default:* `true` - **`enable-industrial-ci` | `ENABLE_INDUSTRIAL_CI`** Enable [*industrial_ci*](https://github.com/ros-industrial/industrial_ci) diff --git a/action.yml b/action.yml index ebf032c..99d3720 100644 --- a/action.yml +++ b/action.yml @@ -117,11 +117,11 @@ inputs: default: false enable-checkout: - description: "Enable checkout of repository prior to running the pipeline" + description: "Enable checkout action to (re-)download your repository prior to running the pipeline" default: true enable-checkout-lfs: - description: "Enable download of lfs files for the repository checkout" + description: "Enable git-lfs support for the checkout action " default: true