Gitops promotion hooks #1277
Gitops promotion hooks #1277
Conversation
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
_docs/promotions/promotion-hooks.md
Outdated
| export JIRA_ISSUE_BASE_URL="{{inputs.parameters.JIRA_BASE_URL}}" | ||
| export JIRA_ISSUE_SOURCE_FIELD="{{inputs.parameters.JIRA_ISSUE_SOURCE_FIELD}}" | ||
| PROMOTION_CONTEXT=$(echo "{\"JIRA_ISSUE_URL\": \"${JIRA_ISSUE_BASE_URL}/browse/${JIRA_ISSUE_SOURCE_FIELD}\"}") | ||
| echo "$PROMOTION_CONTEXT" > /tmp/promotion-context.txt |
There was a problem hiding this comment.
again here the important part is the output param, need to add it to the example yaml as well
_docs/promotions/promotion-hooks.md
Outdated
| Expose the file with the promotion context as an output parameter to make it available to promotion mechanism. | ||
| * Add `PROMOTION_CONTEXT` as the `name` to `outputs.parameters`. _The name must not be changed_. | ||
| * Add the `globalName` attribute to make it available globally. The value must be identical to the name of the promotion context. | ||
| * `valueFrom` attribute to reference the file path |
There was a problem hiding this comment.
potentially they can take it wherever they want from
Edits after feedback from Dev
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
Added draft diagram for promotion context behavior and content updates
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
…esh-io/docs.codefresh.io into gitops-promotion-hooks
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
Added walkthrough example for promotion context
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
Added example template to define promotion context and use in promotion hook
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
1 similar comment
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
| * **Use a custom service account** | ||
| Use your own service account, and bind it to the default service role, `cf-default-promotion-workflows-role`. | ||
|
|
||
| ## Example of service account and service role |
There was a problem hiding this comment.
Example of a Service Account and a Role
There was a problem hiding this comment.
Same as above; fixed the role but leaving in lowercase
_docs/promotions/promotion-hooks.md
Outdated
| Explore examples in [Codefresh Hub for Argo](https://codefresh.io/argohub/){:target="\_blank"}. | ||
|
|
||
| ##### Arguments in promotion hooks | ||
| A default set of arguments are available to all Promotion Workflows with hooksd. See [Default arguments in Promotion Workflows with hooks](#default-arguments-for-promotion-hooks). |
_docs/promotions/promotion-hooks.md
Outdated
| Explore examples in [Codefresh Hub for Argo](https://codefresh.io/argohub/){:target="\_blank"}. | ||
|
|
||
| ##### Arguments in promotion hooks | ||
| A default set of arguments are available to all Promotion Workflows with hooksd. See [Default arguments in Promotion Workflows with hooks](#default-arguments-for-promotion-hooks). |
There was a problem hiding this comment.
This link:
[Default arguments in Promotion Workflows with hooks](#default-arguments-for-promotion-hooks).
doesn't work for me
_docs/promotions/promotion-hooks.md
Outdated
|
|
||
| The table lists key differences between Promotion Workflows containing hooks and Promotion (Pre- and Post-Action) Workflows. | ||
|
|
||
| | **Feature** | **Promotion Hooks in Workflows** | **Pre- and Post-Action Workflows** | |
There was a problem hiding this comment.
I think that if we're making reference to "Pre- and Post-Action Workflows", then the second column should be "Promotion Hooks Workflows" (without the in)
There was a problem hiding this comment.
Yes, I had that in the beginning but changed it later. I think I'll add a heading Promotion Workflows and then two column headings below Promotion Hooks and Pre-and Post-Action
Implemented feedback from Francisco's review
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
Added note on early access availability for publish
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
…esh-io/docs.codefresh.io into gitops-promotion-hooks
|
"[CI] Staging environment is at http://staging-docs.codefresh.io.s3-website.us-east-1.amazonaws.com/gitops-auto-promotion-req/docs/" |
First dart of promotion hooks