Skip to content

Commit d6a5bad

Browse files
authored
fix!: change checkout_repository default to false (#7)
1 parent e42e0fd commit d6a5bad

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ jobs:
1818
build-src-package:
1919
runs-on: ubuntu-latest
2020
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v4
23+
2124
- name: Create package
2225
uses: minvws/action-generic-build-package@v1
2326
with:
@@ -34,12 +37,11 @@ In this basic example, the workflow is executed automatically on push of tags.
3437

3538
The action has the following inputs:
3639

37-
- `include_paths`: A space-separated list with files and directories to include in the package relative to the working_directory.
38-
- `package_file_name`: Name of the package (without extension), for example: `nl-example-package`.
39-
- `working_directory`: The base directory containing the source code, only required if it does not need to be the root folder.
40-
- `version_json_path`: The location where version.json needs to be stored. For example `public/version.json`. Default: `version.json`.
41-
- `checkout_repository`: Boolean value inside string to enable or disable checkout repository
42-
in the action. For example `"true"` or `"false"`. Default `"true"`.
40+
- `package_file_name`: Name of the package (without extension), for example: `nl-example-package`. Required.
41+
- `include_paths`: A space-separated list with files and directories to include in the package, relative to the `working_directory`. Optional, default: `"."`.
42+
- `working_directory`: The base directory containing the source code, relative to the project root. Optional, default: `"."`.
43+
- `version_json_path`: The location where version.json needs to be stored. For example `public/version.json`. Optional, default: `version.json`.
44+
- `checkout_repository`: Whether to checkout the repository in the action. Boolean string, for example `"true"`. Optional, default: `"false"`.
4345

4446
### Result
4547

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ inputs:
2020
checkout_repository:
2121
description: "Whether to checkout the repository (true or false)."
2222
required: false
23-
default: 'true'
23+
default: "false"
2424

2525
runs:
2626
using: "composite"
2727
steps:
2828
- name: Checkout code
29-
if: inputs.checkout_repository == 'true'
29+
if: inputs.checkout_repository == "true"
3030
uses: actions/checkout@v5
3131

3232
- name: Extract version from tag

0 commit comments

Comments
 (0)