Skip to content

Commit

Permalink
added an example
Browse files Browse the repository at this point in the history 
Signed-off-by: Hanan Younes <hanan.algazaley@gmail.com>
  • Loading branch information
@hyounes4560
hyounes4560 committed Oct 30, 2024
1 parent 18a1208 commit 1e0fd93
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions content/docs/for-platform-operators/how-to/build-inputs/build-env.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,20 @@ When more than one entity specifies the same `environment variable`, the order o

The platform operator specifies `environment variables` in a manner that is very similar to buildpacks (see XXX), but with a few differences. Namely:

Check warning on line 16 in content/docs/for-platform-operators/how-to/build-inputs/build-env.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Contractions] Use 'that's' instead of 'that is'.

Raw Output:
{"message": "[Google.Contractions] Use 'that's' instead of 'that is'.", "location": {"path": "content/docs/for-platform-operators/how-to/build-inputs/build-env.md", "range": {"start": {"line": 16, "column": 69}}}, "severity": "INFO"}

Check warning on line 16 in content/docs/for-platform-operators/how-to/build-inputs/build-env.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "content/docs/for-platform-operators/how-to/build-inputs/build-env.md", "range": {"start": {"line": 16, "column": 104}}}, "severity": "INFO"}

Check warning on line 16 in content/docs/for-platform-operators/how-to/build-inputs/build-env.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'XXX', if it's unfamiliar to the audience.

Raw Output:
{"message": "[Google.Acronyms] Spell out 'XXX', if it's unfamiliar to the audience.", "location": {"path": "content/docs/for-platform-operators/how-to/build-inputs/build-env.md", "range": {"start": {"line": 16, "column": 109}}}, "severity": "INFO"}

* The env directory is `/cnb/build-config`
* The directory for environment variable settings `/cnb/build-config`
* When no suffix is provided, the modification behavior is `default`

Check warning on line 19 in content/docs/for-platform-operators/how-to/build-inputs/build-env.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is provided').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is provided').", "location": {"path": "content/docs/for-platform-operators/how-to/build-inputs/build-env.md", "range": {"start": {"line": 19, "column": 18}}}, "severity": "INFO"}
For more information, consult the [Platform Specification](https://github.com/buildpacks/spec/blob/main/platform.md).

### Example

PLACEHOLDER
Platform operators can make choices that "override" or provide defaults for application authors. In the following configuration the platform operator overrides the value of `CGO_ENABLED` for all application authors. The value of `PIP_VERBOSE` is set by default and can be overridden by buildpack authors or application authors. Any value for the environment variable `CLASSPATH` is prepended with the values provided by the platform operator.

Check failure on line 24 in content/docs/for-platform-operators/how-to/build-inputs/build-env.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Spacing] 's. I' should have one space.

Raw Output:
{"message": "[Google.Spacing] 's. I' should have one space.", "location": {"path": "content/docs/for-platform-operators/how-to/build-inputs/build-env.md", "range": {"start": {"line": 24, "column": 95}}}, "severity": "ERROR"}

Check failure on line 24 in content/docs/for-platform-operators/how-to/build-inputs/build-env.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Spacing] 's. T' should have one space.

Raw Output:
{"message": "[Google.Spacing] 's. T' should have one space.", "location": {"path": "content/docs/for-platform-operators/how-to/build-inputs/build-env.md", "range": {"start": {"line": 24, "column": 215}}}, "severity": "ERROR"}

Check failure on line 24 in content/docs/for-platform-operators/how-to/build-inputs/build-env.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Spacing] 's. A' should have one space.

Raw Output:
{"message": "[Google.Spacing] 's. A' should have one space.", "location": {"path": "content/docs/for-platform-operators/how-to/build-inputs/build-env.md", "range": {"start": {"line": 24, "column": 328}}}, "severity": "ERROR"}

```bash
$ tree /cnb/buildconfig/env
├── CGO_ENABLED.override
├── PIP_VERBOSE
└── CLASSPATH.prepend
```

[env]: https://buildpacks.io/docs/for-buildpack-authors/how-to/write-buildpacks/specify-env/
[end user]: https://buildpacks.io/docs/for-app-developers/how-to/build-inputs/configure-build-time-environment/

0 comments on commit 1e0fd93

Please sign in to comment.