Skip to content
This repository was archived by the owner on Nov 30, 2023. It is now read-only.

Commit 27ba89c

Browse files
authored
fix link (#1264)
1 parent f26ca6b commit 27ba89c

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

script-library/container-features/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ This folder includes some explorations around dynamic container feature injectio
88

99
**Registering a feature**
1010

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`
1212

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:
1414

1515
```json
1616
{
@@ -36,7 +36,7 @@ Add a new object to the [features.json](script-library/container-features/src/fe
3636
}
3737
```
3838

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).
4040

4141
```
4242
_VSC_INSTALL_<FEATURE>="<feature>-debian.sh ${_BUILD_ARG_<FEATURE>_<OPTION1>:-<option1 default>} ${_BUILD_ARG_<FEATURE>_<OPTION2>:-<option2 default>} hardcodedThirdArgument"
@@ -59,7 +59,7 @@ _VSC_INSTALL_<FEATURE>="<feature>-debian.sh ${_BUILD_ARG_<FEATURE>_<OPTION1>:-<o
5959
Repeat as needed to iterate from a clean workspace.
6060

6161
*Unit tests*
62-
- Add your feature to the [run-scripts.sh](script-library/test/regression/run-scripts.sh) file to ensure it is included in CI tests.
62+
- Add your feature to the [run-scripts.sh](../../script-library/test/regression/run-scripts.sh) file to ensure it is included in CI tests.
6363

6464
- Your addition should take the form `runScript <feature> <non-default-args>`.
6565

@@ -71,7 +71,7 @@ runScript dotnet "3.1 true ${USERNAME} false /opt/dotnet dotnet"
7171
- If your script takes the installation user as an argument, be sure to specify it as ${USERNAME} in the tests for programatic testing.
7272

7373
*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.
7575

7676
EG
7777
```
@@ -150,8 +150,8 @@ Feel free to use other scripts in that directory as inspiration.
150150

151151
- 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.
152152

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.
154154
- NOTE: This is done to minimize the impact that any change can have on existing working scripts.
155155
- 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.
156156

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

Comments
 (0)