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.

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

Expand-app-developers-pages #777

Merged
Prev Previous commit
Next Next commit
adds exp. features list
Signed-off-by: Hanan Younes <[email protected]>
hyounes4560 committed Nov 12, 2024
commit 4178e77faca941836a84af44005cf80be20a5e91
Original file line number Diff line number Diff line change
@@ -3,16 +3,25 @@
weight=8
+++

Certain features are considered `experimental` and susceptible to change in a future API version.

Check warning on line 6 in content/docs/for-app-developers/concepts/experimental-features.md

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('are considered'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('are considered').", "location": {"path": "content/docs/for-app-developers/concepts/experimental-features.md", "range": {"start": {"line": 6, "column": 18}}}, "severity": "INFO"}
hyounes4560 marked this conversation as resolved.
Show resolved Hide resolved

<!--more-->

This means users will need to enable the `experimental` mode in order to use one of these feature.
This means users will need to enable the `experimental` mode in order to use one of these features.

Check warning on line 10 in content/docs/for-app-developers/concepts/experimental-features.md

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-app-developers/concepts/experimental-features.md", "range": {"start": {"line": 10, "column": 18}}}, "severity": "WARNING"}

Check warning on line 10 in content/docs/for-app-developers/concepts/experimental-features.md

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.WordList] Use 'to' instead of 'in order to'. Raw Output: {"message": "[Google.WordList] Use 'to' instead of 'in order to'.", "location": {"path": "content/docs/for-app-developers/concepts/experimental-features.md", "range": {"start": {"line": 10, "column": 62}}}, "severity": "WARNING"}

To enable these features, run `pack config experimental true`, or add `experimental = true` to the `~/.pack/config.toml` file.
hyounes4560 marked this conversation as resolved.
Show resolved Hide resolved
hyounes4560 marked this conversation as resolved.
Show resolved Hide resolved

For example, exporting your application to disk in `OCI` layout format is an experimental feature available on `pack` since version `v0.30.0`
For example, exporting your application to disk in `OCI` layout format is an experimental feature available on `pack` since version `v0.30.0`.

Check warning on line 14 in content/docs/for-app-developers/concepts/experimental-features.md

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.WordList] Use 'app' instead of 'application'. Raw Output: {"message": "[Google.WordList] Use 'app' instead of 'application'.", "location": {"path": "content/docs/for-app-developers/concepts/experimental-features.md", "range": {"start": {"line": 14, "column": 29}}}, "severity": "WARNING"}

The following is a list of experimental features:

* Image extensions
* Windows extensions
* Windows containers
* Windows buildpackage
* Buildpack registry
* Flattening a buildpack package

For more information and to look at an example of how this might be valuable, see [Export to OCI layout format on disk][exp-feature].

Check warning on line 25 in content/docs/for-app-developers/concepts/experimental-features.md

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.Acronyms] Spell out 'OCI', if it's unfamiliar to the audience. Raw Output: {"message": "[Google.Acronyms] Spell out 'OCI', if it's unfamiliar to the audience.", "location": {"path": "content/docs/for-app-developers/concepts/experimental-features.md", "range": {"start": {"line": 25, "column": 94}}}, "severity": "INFO"}

[exp-feature]: https://buildpacks.io/docs/for-app-developers/how-to/special-cases/export-to-oci-layout/
hyounes4560 marked this conversation as resolved.
Show resolved Hide resolved

Unchanged files with check annotations Beta

Apart from the above standard metadata, buildpacks can also populate information about the dependencies they have provided in form of a `Software Bill-of-Materials` or [SBOM].
As already mentioned, buildpacks help you get an `OCI` images that are constructed in a way that’s easy to understand and update with each of the layers being meaningful and independent of all other layers. You can get more details about each layer and how it was created to better understand how the [Build] actually worked.

Check warning on line 42 in content/docs/for-app-developers/how-to/build-outputs/inspect-app.md

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('are constructed'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('are constructed').", "location": {"path": "content/docs/for-app-developers/how-to/build-outputs/inspect-app.md", "range": {"start": {"line": 42, "column": 68}}}, "severity": "INFO"}

Check warning on line 42 in content/docs/for-app-developers/how-to/build-outputs/inspect-app.md

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('was created'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('was created').", "location": {"path": "content/docs/for-app-developers/how-to/build-outputs/inspect-app.md", "range": {"start": {"line": 42, "column": 261}}}, "severity": "INFO"}
There are some available tools that help you achieve this and understand what is contained in your `OCI` image; a popular one is [Dive].

Check warning on line 44 in content/docs/for-app-developers/how-to/build-outputs/inspect-app.md

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.Contractions] Use 'what's' instead of 'what is'. Raw Output: {"message": "[Google.Contractions] Use 'what's' instead of 'what is'.", "location": {"path": "content/docs/for-app-developers/how-to/build-outputs/inspect-app.md", "range": {"start": {"line": 44, "column": 74}}}, "severity": "INFO"}

Check warning on line 44 in content/docs/for-app-developers/how-to/build-outputs/inspect-app.md

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('is contained'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('is contained').", "location": {"path": "content/docs/for-app-developers/how-to/build-outputs/inspect-app.md", "range": {"start": {"line": 44, "column": 79}}}, "severity": "INFO"}

Check warning on line 44 in content/docs/for-app-developers/how-to/build-outputs/inspect-app.md

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.Semicolons] Use semicolons judiciously. Raw Output: {"message": "[Google.Semicolons] Use semicolons judiciously.", "location": {"path": "content/docs/for-app-developers/how-to/build-outputs/inspect-app.md", "range": {"start": {"line": 44, "column": 111}}}, "severity": "INFO"}
Dive can help you inspect `OCI` images, view their layers and each layer's details. If you were to build an `OCI` image following the [multi process app] example and run `Dive` on the generated image, you'll be presented with some detailed information about all of the image layers and understand what is in each layer.