Skip to content

Commit cf8c729

Browse files
committed
docs: add demo images showcase and automate release tagging
- Add demo images table to README showing CLI usage, Web UI assets, and workflow visualization - Reposition demo images table to appear after Quickstart section for better content flow - Add GitHub Actions step to automatically mark releases as latest in manual-release workflow
1 parent c5e489b commit cf8c729

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

.github/workflows/manual-release.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,11 @@ jobs:
4848
env:
4949
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5050
GORELEASER_CURRENT_TAG: ${{ steps.get-tag.outputs.tag }}
51+
52+
- name: Mark release as latest
53+
env:
54+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
55+
run: |
56+
TAG="${{ steps.get-tag.outputs.tag }}"
57+
echo "Marking $TAG as latest release"
58+
gh release edit "$TAG" --latest

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ curl -sSL http://www.osmedeus.org/install.sh | bash
4646

4747
See [Quickstart](https://docs.osmedeus.org/quickstart/) for quick setup and [Installation](https://docs.osmedeus.org/installation/) for advanced configurations.
4848

49+
| CLI Usage | Web UI Assets | Workflow Visualization |
50+
|-----------|--------------|-----------------|
51+
| ![CLI Usage](https://raw.githubusercontent.com/osmedeus/assets/refs/heads/main/demo-images/cli-run-with-verbose-output.png) | ![Web UI Assets](https://raw.githubusercontent.com/osmedeus/assets/refs/heads/main/demo-images/web-ui-assets.png) | ![Workflow Visualization](https://raw.githubusercontent.com/osmedeus/assets/refs/heads/main/demo-images/web-ui-workflow.png) |
52+
4953
## Quick Start
5054

5155
```bash
@@ -92,9 +96,6 @@ docker run --rm -v $(pwd)/output:/root/workspaces-osmedeus \
9296

9397
For more CLI usage and example commands, refer to the [CLI Reference](https://docs.osmedeus.org/getting-started/cli).
9498

95-
| CLI Usage | Web UI Assets | Web UI Workflow |
96-
|-----------|--------------|-----------------|
97-
| ![CLI Usage](https://raw.githubusercontent.com/osmedeus/assets/refs/heads/main/demo-images/cli-run-with-verbose-output.png) | ![Web UI Assets](https://raw.githubusercontent.com/osmedeus/assets/refs/heads/main/demo-images/web-ui-assets.png) | ![Web UI Workflow](https://raw.githubusercontent.com/osmedeus/assets/refs/heads/main/demo-images/web-ui-workflow.png) |
9899

99100
## Core Components
100101

0 commit comments

Comments
 (0)