Add state section to porter.yaml #1743
Merged
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
carolynvs
force-pushed
the
state2
branch
4 times, most recently
from
4805848
to
eda56ee
Compare
|
/azp run porter-integration |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Allow bundle authors to flag files as "state" that should be persisted by the bundle, but not exposed to the user (like a parameter or output is). Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
Some outputs and parameters are really porter "plumbing". They are used by porter to implement things, like state or persistent parameters, but aren't intended to be set or used by the end-user. When we print out how to use a bundle with porter explain, those shoudn't be displayed. * Parameters with sources - these will be set by Porter internally. * Outputs and Parameters that support bundle state. Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
|
/azp run porter-integration |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Allow integration tests to also use run commands using the porter CLI. Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
|
/azp run porter |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run porter-integration |
|
Azure Pipelines successfully started running 1 pipeline(s). |
carolynvs
commented
Sep 9, 2021
| @@ -179,7 +181,7 @@ func (c *ManifestConverter) generateBundleParameters(defs *definition.Definition | |||
| if !param.Destination.IsEmpty() { | |||
| p.Destination = &bundle.Location{ | |||
| EnvironmentVariable: param.Destination.EnvironmentVariable, | |||
| Path: param.Destination.Path, | |||
| Path: manifest.ResolvePath(param.Destination.Path), | |||
There was a problem hiding this comment.
In a follow-up PR I want to use this function so that people can use relative paths not just for the state files, but for params and creds. That way we should see a lot less of hard-coding absolute paths like /cnab/app/mystuff, when they just use "mystuff" and assume that everything is relative to the bundle directory.
carolynvs
commented
Sep 9, 2021
| @@ -59,7 +59,7 @@ func TestPorter_Build(t *testing.T) { | |||
|
|
|||
| stamp, err := configadapter.LoadStamp(bun) | |||
| require.NoError(t, err) | |||
| assert.Equal(t, "d421a6249dfbdba79e26e866da7533d59590565708dfdb32423cf989f588d0ea", stamp.ManifestDigest) | |||
| assert.NotEmpty(t, stamp.ManifestDigest) | |||
There was a problem hiding this comment.
I've gotten super tired of checking and updating the exact manifest digest. We just update it every time we tweak the bundle which isn't helpful.
carolynvs
commented
Sep 9, 2021
| } | ||
|
|
||
| // TODO(carolynvs): hack around parameters ALWAYS being injected even when empty files mess things up |
There was a problem hiding this comment.
I logged a bug against cnab-go cnabio/cnab-go#266 and will work on fixing this after I get this stuff in.
vdice
approved these changes
Sep 14, 2021
pkg/runtime/runtime-manifest.go
Outdated
| return bigErr.ErrorOrNil() | ||
| } | ||
|
|
||
| // applyUnboundBundleOutputs find outputs that haven't been bound yet by a step, |
There was a problem hiding this comment.
Suggested change
| // applyUnboundBundleOutputs find outputs that haven't been bound yet by a step, | |
| // applyUnboundBundleOutputs finds outputs that haven't been bound yet by a step, |
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.
What does this change
Allow bundle authors to flag files as "state" that should be persisted by the bundle, but not exposed to the user (like a parameter or output is).
Allow file parameters to be optional. When injecting a parameter into the bundle and the type is "file" do not inject the word null into the file in the bundle, omit it. I have an open issue to correct this in upstream cnab-go Optional parameters are not injected properly cnabio/cnab-go#266.
Hide porter internal from explain command. Some outputs and parameters are really porter "plumbing". They are used by porter to implement things, like state or persistent parameters, but aren't intended to be set or used by the end-user.
When we print out how to use a bundle with porter explain, those shouldn't be displayed.
What issue does it fix
Implements the new state section proposed in #1672.
Notes for the reviewer
Preview of the state docs @ https://deploy-preview-1743--porter.netlify.app/author-bundles/#state
Checklist