chore: Update docs to prepare for v1.0.0 release #133
+28
−42
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kbdharun
approved these changes
Jan 20, 2025
| } | ||
| ``` | ||
|
|
||
| Vib gets the plugin type from the `type` field: `0` means `BuildPlugin`, and `1` means `FinalizePlugin`. For this article, it should be set to `0`, as it does not cover the requirements for a finalize plugin. | ||
|
|
||
| `usecontainercmds` tells vib wether the plugin adds the relevant containerfile directives itself, or if vib should automatically prepend `CMD` to them, this allows plugins to do more advanced things outside of just specifing commands to run. |
There was a problem hiding this comment.
Suggested change
| `usecontainercmds` tells vib wether the plugin adds the relevant containerfile directives itself, or if vib should automatically prepend `CMD` to them, this allows plugins to do more advanced things outside of just specifing commands to run. | |
| `usecontainercmds` tells vib whether the plugin adds the relevant containerfile directives itself, or if vib should automatically prepend `CMD` to them, this allows plugins to do more advanced things outside of just specifing commands to run. |
| @@ -182,6 +184,7 @@ Each stage has the following fields: | |||
| - `entrypoint`: the entry point for the container, it's similar to `cmd` but it's not overridden by the command passed to the container at runtime, useful to handle the container as an executable. | |||
| - `copy`: a list of files or directories to copy from another stage (or copy from host), useful to copy files from one stage to another. | |||
| - `modules`: a list of modules to use in the stage. | |||
| - `addincludes`: wether `includes.container` should be copied into this stage | |||
There was a problem hiding this comment.
Suggested change
| - `addincludes`: wether `includes.container` should be copied into this stage | |
| - `addincludes`: whether `includes.container` should be copied into this stage |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This updates the docs to make them accurate for the upcoming 1.0.0 release