11# github-release-example
2- An example of how an approval for release to a protected environment in GitHub can be
3- logged as an attestation in Kosli.
2+ An example of how an approval in a GitHub workflow can be logged as an attestation in Kosli.
43
54## How to demo
65
6+ ### Setup
7+ There is a separate [ GitHub workflow] ( https://github.com/kosli-dev/github-release-example/actions/workflows/setup-kosli.yml )
8+ to create the [ flow] ( https://app.kosli.com/kosli-public/flows/github-release-example-backend/trails/ )
9+ and the custom attestation [ approval-github-workflow] ( https://app.kosli.com/kosli-public/attestation-types/approval-github-workflow )
10+ used in this demo.
11+
712### Build a new version of backend
8- Make a branch for your change
13+ Make a branch for your change:
914``` shell
1015git checkout -b backent-next-version
1116```
@@ -17,9 +22,11 @@ apps/backend/backend-content.txt
1722Commit and push the change to GitHub.
1823Create a Pullrequest and merge the change back to main.
1924
20- This will trigger a workflow in [ GitHub] ( https://github.com/kosli-dev/github-release-example/actions/workflows/build-deploy-backend.yml )
25+ This will trigger a [ Build and deploy] ( https://github.com/kosli-dev/github-release-example/actions/workflows/build-deploy-backend.yml )
26+ workflow in GitHub.
2127
22- You now have to approve the deployment to ` staging envirnment `
28+ The GitHub workflow will stopp after a short period waiting for your approval of deploying
29+ the SW to Stage. Approve it and the workflow will finish.
2330
2431You should now have a trail that matches the commit in the
2532[ github-release-example-backend] ( https://app.kosli.com/kosli-public/flows/github-release-example-backend/trails/ ) flow.
@@ -40,6 +47,6 @@ This will trigger the same workflow in [GitHub](https://github.com/kosli-dev/git
4047
4148The trail name will match the version tag.
4249
43- Approve the SW for staging first, and then for production .
50+ Approve the SW for ` Stage ` first, and then for ` Production ` .
4451
4552In the Kosli trail for the release you will now have a ` release-approval ` in addition to the pull-request and artifact.
0 commit comments