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 template composition example for template; add notifications validation err flag #450

Merged
merged 4 commits into from
Feb 10, 2021

Conversation

tkyi
Copy link
Member

@tkyi tkyi commented Feb 8, 2021

Objective

This PR: addd template composition for template example, updated template TOC, and adds notifications validation err flag and other API settings.

References

Related to screwdriver-cd/screwdriver#2319, screwdriver-cd/screwdriver#2339

License

I confirm that this contribution is made under the terms of the license found in the root directory of this repository's source tree and that I have the authority necessary to make this contribution on behalf of its copyright owner.

@tkyi tkyi requested a review from jithine February 8, 2021 23:26
Copy link
Member

@jithine jithine left a comment

Choose a reason for hiding this comment

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

Also this example is misplaced https://github.com/screwdriver-cd/guide/pull/450/files#diff-0863375e9d888a75cabce90e1d0e8b16a72cb690efab345548edfd00bb842926R261-R302

It's under the main title of Template Composition but the example is for usage of order in a job. I would rather flip the precedence, provide example which shows order usage in Template Composition and just leave a note that order can also used in jobs. (I would rather not highlight order availability for jobs since only power users should have this kind of flexibility )

url: "#writing-a-template-yaml"
subitem: true
- title: Template images
url: "template-images"
Copy link
Member

Choose a reason for hiding this comment

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

missing #

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed

url: "#template-composition"
subitem: true
- title: Writing a screwdriver yaml
url: "#writing-a-screwdriveryaml"
Copy link
Member

@jithine jithine Feb 9, 2021

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed

### Template Composition
You can also use a template in the `config` section of an `sd-template.yaml` file.

Caveats:
Copy link
Member

Choose a reason for hiding this comment

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

change to Caveats when using order ?

Copy link
Member Author

Choose a reason for hiding this comment

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

updated

@jithine jithine merged commit 6e86b87 into master Feb 10, 2021
@jithine jithine deleted the add_example branch February 10, 2021 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants