Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for 'platform.os' field in package.toml #242

Merged
merged 2 commits into from
Nov 12, 2020
Merged

Add docs for 'platform.os' field in package.toml #242

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f745e9
Add docs for 'platform.os' field in package.toml
Oct 28, 2020
6e7ec38
Merge branch 'main' into feature/package-buildpack-os-configuration
jromero Nov 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions content/docs/reference/config/package-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ A [buildpackage][package] configuration schema is as follows:
- **`image`** _(string)_\
A registry location (if no registry host is specified in the image name, DockerHub is assumed).

- #### `platform` _(optional)_
The expected runtime environment for the buildpackage. It should contain the following field:

- **`os`** _(string, optional)_\
The operating system type that the buildpackage will run on. Only `linux` or `windows` is supported. If omitted, `linux` will be the default.


## Further Reading

You can view [sample buildpackages](/~https://github.com/buildpacks/samples/tree/main/packages) on Github.
Expand Down