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

feat: add docs for new render inline option #291

Merged
merged 4 commits into from
Apr 5, 2022
Merged

Conversation

kneal
Copy link
Contributor

@kneal kneal commented Mar 17, 2022

Related to: go-vela/community#233

@kneal kneal added the feature Indicates a new feature label Mar 17, 2022
@kneal kneal self-assigned this Mar 17, 2022
@wass3r wass3r added the next label Mar 17, 2022
@wass3r wass3r removed the next label Mar 25, 2022
|-----------------|----------|------|--------------------------------------------------------|
| `template` | Y | bool | Enables compiling the pipeline as a template. |
| `clone` | N | bool | Enables injecting the default clone process. |
| `render_inline` | N | bool | Enables rendering for templates without stages/steps. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i don't think this description is quite accurate? you can have either as long as the template has the same (ie. template injects stages, your base pipeline needs to have stages too). in fact, should that factoid be called out somewhere?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that's what it can do but probably not phrased in the correct spot. It's weird because the work was done in the story to enable Stages for templates but the feature does that indirectly by unlocking many more features.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess we'll merge as is and amend after.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(ie. template injects stages, your base pipeline needs to have stages too)

The examples provided in the other file are stages injections. I would hope that would be intuitive enough to show that stages can be templated but I suppose we could be more specific.

@wass3r wass3r marked this pull request as ready for review April 5, 2022 00:11
@wass3r wass3r requested a review from a team as a code owner April 5, 2022 00:11
wass3r
wass3r previously approved these changes Apr 5, 2022
Copy link
Member

@cognifloyd cognifloyd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooh. This looks like a sweet feature!

Copy link
Collaborator

@wass3r wass3r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@wass3r wass3r merged commit cc97f12 into master Apr 5, 2022
@wass3r wass3r deleted the feat/render_inline branch April 5, 2022 22:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Indicates a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants