Skip to content

Commit 18af80d

Browse files
authored
Added demo instructions (#147)
1 parent 98695e8 commit 18af80d

File tree

3 files changed

+89
-4
lines changed

3 files changed

+89
-4
lines changed

README.md

Lines changed: 87 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,6 @@ and usage of it in `release-to-prod.yml`.
181181
Make the scripts a little more streamlined and make it easy to just give
182182
a list of apps/environments and loop over them.
183183

184-
There is no CLI command to get the Jira-issues from Kosli, so I have to use curl.
185-
186184
I report the Jira issue and pull request on both the source and build flows. A link
187185
from the source trail to build trail would be nice. But for proper linking we
188186
need to let a trail event on one trail trigger also a trail event on the other trails that it
@@ -201,3 +199,90 @@ also the combination running in production?
201199
- I do a lot of API calls to get the list of commits in a release, and then
202200
I loop over all the commits to collect all the Jira issues included. This
203201
gives me some complicated bash scripts, which is hard to maintain.
202+
203+
204+
# Customer demo
205+
206+
## Preparation
207+
Make sure there are no pending release in
208+
https://kosli-team.atlassian.net/projects/OPS?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page
209+
210+
Make sure the environment reporting is up to date
211+
make report_all_envs
212+
213+
## With customer
214+
Show them the board https://kosli-team.atlassian.net/jira/software/projects/OPS/boards/1
215+
Add a jira issue in **IN PROGRESS** with some description: Make the app great again
216+
Show them that there are no open releases
217+
https://kosli-team.atlassian.net/projects/OPS?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page
218+
219+
Make a branch that matches the name
220+
git checkout -b OPS-xx-improve-app
221+
Update the two files by increasing the number:
222+
apps/backend/backend-content.txt
223+
apps/frontend/frontend-content.txt
224+
Commit, push and make a PR
225+
git commit -m "Made the app create agin"
226+
git push
227+
gh pr create
228+
Approve the PR in github https://github.com/kosli-dev/jira-integration-example/pulls
229+
You should now have three jobs running in actions
230+
- Build Backend
231+
- Build Frontend
232+
- Attest Source Controls
233+
234+
Let all jobs finish and then force reporting of what is running in each environment
235+
make report_all_envs
236+
237+
You can now show that the updated is running in development
238+
https://app.kosli.com/kosli-public/environments/jira-integration-example-dev/snapshots/
239+
240+
Deploy development SW to staging and when that job has finished you can report environments again
241+
make deploy_to_staging
242+
WAIT
243+
make report_all_envs
244+
245+
The SW is now running in staging
246+
https://app.kosli.com/kosli-public/environments/jira-integration-example-staging/snapshots/
247+
248+
Create a release candidate
249+
make create_release_candidate
250+
251+
Show the customer the new release
252+
https://kosli-team.atlassian.net/projects/OPS?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page
253+
Press the release and show them that the Jira issue you created is part of the release. If there are more there
254+
it is just because there was some other updates also included.
255+
256+
There is no API in Jira to add an approver for a release so you have to do this manually. You find this on the
257+
right hand side. You can also show them that it is marked as **Unreleased**
258+
259+
You can now trigger a release to production which will fail since not all approvers has approved it
260+
make check_release_to_prod
261+
262+
### Fast demo
263+
Depending on how much time you have now you can release what you have now by setting the release to APPROVED
264+
in the release web page. Then run the release, wait and then update the environments
265+
make check_release_to_prod
266+
WAIT
267+
make report_all_envs
268+
269+
### Extended demo
270+
Go back to the Jira board and make a new Jira issue: Improve frontend
271+
- make branch
272+
- update apps/frontend/frontend-content.txt
273+
- git commit, push, create pr
274+
- approve pr
275+
- WAIT
276+
- make report_all_envs
277+
- WAIT
278+
- make deploy_to_staging
279+
- WAIT
280+
- make report_all_envs
281+
- WAIT
282+
283+
Now we have the new fix for frontend running in staging. The backend SW is the same as before.
284+
Update the Jira release so we also include the new Jira issue
285+
make update_release_candidate
286+
287+
Show the release (you must reload the page) to show that the new Jira issue is in the list
288+
Now you can now follow the steps in Fast Demo to finish the demo

apps/backend/backend-content.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
This is just a file to test out that changes to back-end source code
22
can trigger a build, reporting to Kosli and Jira
33

4-
counter=69
4+
counter=70

apps/frontend/frontend-content.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
This is just a file to test out that changes to front-end source code
22
can trigger a build, reporting to Kosli and Jira
33

4-
counter=54
4+
counter=55

0 commit comments

Comments
 (0)