Skip to content

Commit

Permalink
adds few updates & links
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 26, 2024
1 parent 811a4aa commit a51eed2
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 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 @@ -3,16 +3,25 @@ title="Specify the build time environment variables"
weight=4
+++

Environment variables are any values used to allow `Buildpacks` configurability. Some environment variables can't be modified while others are expected to get changed to allow a level of customization.
Environment variables are used to configure buildpack behavior. They may be specified by:

Check warning on line 6 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 ('are used').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are used').", "location": {"path": "content/docs/for-platform-operators/how-to/build-inputs/build-env.md", "range": {"start": {"line": 6, "column": 23}}}, "severity": "INFO"}

Check warning on line 6 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 ('be specified').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be specified').", "location": {"path": "content/docs/for-platform-operators/how-to/build-inputs/build-env.md", "range": {"start": {"line": 6, "column": 74}}}, "severity": "INFO"}

* The platform operator (this page)

Check warning on line 8 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": 8, "column": 25}}}, "severity": "INFO"}
* The end user (see [Customize buildpack behavior with build-time environment variables][end user])
* Other buildpacks (see [Specify the environment][env])

Check warning on line 10 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": 10, "column": 1}}}, "severity": "INFO"}

<!--more-->

At `build` time, platform operators usually control what is included in the `build` environment because `platform-defined` environment variables override any previous values such as `user-provided` and `buildpack-provided` variables.
When more than one entity specifies the same environment variable, the order of precedence is as shown above, with the platform operator having ultimate say over what the final value of the variable will be.

Check warning on line 14 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.WordList] Use 'preceding' instead of 'above'.

Raw Output:
{"message": "[Google.WordList] Use 'preceding' instead of 'above'.", "location": {"path": "content/docs/for-platform-operators/how-to/build-inputs/build-env.md", "range": {"start": {"line": 14, "column": 104}}}, "severity": "WARNING"}

Check warning on line 14 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.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "content/docs/for-platform-operators/how-to/build-inputs/build-env.md", "range": {"start": {"line": 14, "column": 200}}}, "severity": "WARNING"}

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": 67}}}, "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": 102}}}, "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": 107}}}, "severity": "INFO"}

* The env directory is `/cnb/build-config`

Check failure on line 18 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 🐶
[Vale.Spelling] Did you really mean 'env'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'env'?", "location": {"path": "content/docs/for-platform-operators/how-to/build-inputs/build-env.md", "range": {"start": {"line": 18, "column": 7}}}, "severity": "ERROR"}
* 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

For more details on environment variables, see the [Specify the environment][env] page.

[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 a51eed2

Please sign in to comment.