You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 30, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: script-library/container-features/README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,9 @@ This folder includes some explorations around dynamic container feature injectio
8
8
9
9
**Registering a feature**
10
10
11
-
Create the install script in the [script-library](script-library/) directory with the naming convention `<lowercase-feature-name>-<target-os>.sh`. EG `python-debian.sh` or `common-alpine.sh`
11
+
Create the install script in the [script-library](../../script-library/) directory with the naming convention `<lowercase-feature-name>-<target-os>.sh`. EG `python-debian.sh` or `common-alpine.sh`
12
12
13
-
Add a new object to the [features.json](script-library/container-features/src/features.json) file:
13
+
Add a new object to the [features.json](../../script-library/container-features/src/features.json) file:
14
14
15
15
```json
16
16
{
@@ -36,7 +36,7 @@ Add a new object to the [features.json](script-library/container-features/src/fe
36
36
}
37
37
```
38
38
39
-
Add your buildArg to the [feature-scripts.env](script-library/container-features/src/feature-scripts.env) file with all script arguments specified (even if they duplicate a script default).
39
+
Add your buildArg to the [feature-scripts.env](../../script-library/container-features/src/feature-scripts.env) file with all script arguments specified (even if they duplicate a script default).
- If your script takes the installation user as an argument, be sure to specify it as ${USERNAME} in the tests for programatic testing.
72
72
73
73
*Regression tests*
74
-
- Add your feature to the [test-features.env](script-library/container-features/test-features.env) file to include it in regression tests of the container-feature functionality. By setting the `_VSC_INSTALL_<FEATURE>` ENV VAR to true and adding the expected _BUILD_ARG options for your feature.
74
+
- Add your feature to the [test-features.env](../../script-library/container-features/test-features.env) file to include it in regression tests of the container-feature functionality. By setting the `_VSC_INSTALL_<FEATURE>` ENV VAR to true and adding the expected _BUILD_ARG options for your feature.
75
75
76
76
EG
77
77
```
@@ -150,8 +150,8 @@ Feel free to use other scripts in that directory as inspiration.
150
150
151
151
- Consider using [shellcheck](https://github.com/koalaman/shellcheck) or the [vscode-shellcheck extension](https://github.com/vscode-shellcheck/vscode-shellcheck) to apply linting and static code analysis to the bash script to ensure it is formatted correctly.
152
152
153
-
- Consider using common helper functions from [shared/utils.sh](script-library/shared/utils.sh) when managing common tasks (like updating PATH variables, or managing gpg keys) by copying them directly into your script.
153
+
- Consider using common helper functions from [shared/utils.sh](../../script-library/shared/utils.sh) when managing common tasks (like updating PATH variables, or managing gpg keys) by copying them directly into your script.
154
154
- NOTE: This is done to minimize the impact that any change can have on existing working scripts.
155
155
- Similarly, if you add a helper function to your script that could benefit others in the future, consider adding it to the `shared/utils.sh` file as well.
156
156
157
-
- [shared/settings.env](script-library/shared/settings.env) contains shared environment variables used in many install scripts, such as `GPG Keys` and `Archive Architectures`. Consider adding your new env. variables to this script when applicable, or reusing existing variables when pertinent.
157
+
- [shared/settings.env](../../script-library/shared/settings.env) contains shared environment variables used in many install scripts, such as `GPG Keys` and `Archive Architectures`. Consider adding your new env. variables to this script when applicable, or reusing existing variables when pertinent.
0 commit comments