Skip to content

Commit 5ed3cfa

Browse files
authored
Merge pull request #14 from jupyter-server/add_images
Add Release Screenshots to Documentation
2 parents 571587a + bcf49ec commit 5ed3cfa

10 files changed

+41
-5
lines changed

README.md

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,26 +37,62 @@ When ready to make a release:
3737
2. Select the `Draft Changelog` workflow
3838
3. Run the workflow with the version spec (usually the new version number)
3939

40-
<!-- TODO: Add Draft Changelog workflow screenshot here -->
40+
<p align="center">
41+
<img src="media/draft_changelog_workflow.png" alt="Draft Changelog Workflow"
42+
title="Draft Changelog Workflow" width="50%"/>
43+
</p>
4144

4245
4. When the run completes, review the changelog PR that was opened and make any desired edits.
4346

44-
<!-- TODO: Add Changelog PR screenshot here -->
47+
<p align="center">
48+
<img src="media/draft_changelog_next_step.png" alt="Draft Changelog Next Step"
49+
title="Draft Changelog Next Step" width="50%"/>
50+
</p>
51+
52+
<p align="center">
53+
<img src="media/draft_changelog_pr.png" alt="Draft Changelog Pull Request"
54+
title="Draft Changelog Pull Request" width="50%"/>
55+
</p>
4556

4657
5. Merge the PR
4758
6. Return to the Actions panel in the `jupyter-releaser` fork
4859
7. Select the `Draft Release` workflow
4960

50-
<!-- TODO: Add Draft Release workflow screenshot here -->
61+
<p align="center">
62+
<img src="media/draft_release_workflow.png" alt="Draft Release Workflow"
63+
title="Draft Release Workflow" width="50%"/>
64+
</p>
5165

5266
8. Run the workflow with the same version spec as before, and optionally, a post version spec if you want to go back to a dev version in the target branch.
5367
9. When the workflow completes, go to the releases page in the target repository and verify that the new draft release is there with the correct changelog and dist files.
68+
69+
<p align="center">
70+
<img src="media/draft_release_next_step.png" alt="Draft Release Next Step"
71+
title="Draft Release Workflow" width="50%"/>
72+
</p>
73+
74+
<p align="center">
75+
<img src="media/draft_github_release.png" alt="Draft GitHub Release"
76+
title="Draft GitHub Release" width="50%"/>
77+
</p>
78+
5479
10. Copy the url of the draft release.
5580
11. Run the `Publish Release` workflow from the `jupyter-releaser` fork.
5681

57-
<!-- TODO: Add Publish Release workflow screenshot here -->
82+
<p align="center">
83+
<img src="media/publish_release_workflow.png" alt="Publish Release Workflow"
84+
title="Publish Release Workflow" width="50%"/>
85+
</p>
86+
87+
<p align="center">
88+
<img src="media/publish_release_next_step.png" alt="Publish Release Next Step"
89+
title="Publish Release Next Step" width="50%"/>
90+
</p>
5891

59-
<!-- TODO: Add Github release image here -->
92+
<p align="center">
93+
<img src="media/final_github_release.png" alt="Final GitHub Release"
94+
title="Final GitHub Release" width="50%"/>
95+
</p>
6096

6197
12. If the release was on a backport branch, a forward port PR will have been opened against
6298
the default branch with the new changelog entry. Review and merge this PR.
108 KB
Loading

media/draft_changelog_pr.png

315 KB
Loading

media/draft_changelog_workflow.png

209 KB
Loading

media/draft_github_release.png

574 KB
Loading

media/draft_release_next_step.png

135 KB
Loading

media/draft_release_workflow.png

234 KB
Loading

media/final_github_release.png

572 KB
Loading
111 KB
Loading

media/publish_release_workflow.png

63.5 KB
Loading

0 commit comments

Comments
 (0)