Skip to content

Commit 3610ce4

Browse files
slin1237slin1237
authored
[misc] fix docs, add more workflows (#58)
* [docs] update doc * [misc] fix docs, add more workflows
1 parent 8d05a79 commit 3610ce4

38 files changed

Lines changed: 1547 additions & 59 deletions

‎.github/ISSUE_TEMPLATE/BUG_REPORT.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug encountered while using OME
4+
title: "[BUG] "
5+
labels: kind/bug
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Please use this template while reporting a bug and provide as much info as possible. -->
11+
12+
## What happened?
13+
14+
<!-- A clear and concise description of what the bug is. -->
15+
16+
## What did you expect to happen?
17+
18+
<!-- A clear and concise description of what you expected to happen. -->
19+
20+
## How can we reproduce it (as minimally and precisely as possible)?
21+
22+
<!-- Please provide a step-by-step description of how to reproduce the issue. -->
23+
24+
```yaml
25+
# Example YAML configuration that reproduces the issue
26+
```
27+
28+
## Anything else we need to know?
29+
30+
<!-- Any additional context about the problem. -->
31+
32+
## Environment
33+
34+
- OME version:
35+
- Kubernetes version (use `kubectl version`):
36+
- Cloud provider or hardware configuration:
37+
- OS (e.g., from `/etc/os-release`):
38+
- Runtime (SGLang, vLLM, etc.) and version:
39+
- Model being served (if applicable):
40+
- Install method (Helm, kubectl, etc.):

‎.github/ISSUE_TEMPLATE/ENHANCEMENT.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Enhancement Request
3+
about: Suggest an enhancement to the OME project
4+
title: "[ENHANCEMENT] "
5+
labels: kind/feature
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Please only use this template for submitting enhancement requests -->
11+
12+
## What would you like to be added?
13+
14+
<!-- A clear and concise description of what you want to happen. -->
15+
16+
## Why is this needed?
17+
18+
<!--
19+
Explain why this enhancement would be useful to OME users.
20+
Include use cases and benefits.
21+
-->
22+
23+
## Completion requirements
24+
25+
<!--
26+
This enhancement requires the following artifacts:
27+
28+
- [ ] Design doc (if significant feature)
29+
- [ ] API change
30+
- [ ] Docs update
31+
- [ ] Tests
32+
-->
33+
34+
## Can you help us implement this enhancement?
35+
36+
<!--
37+
Let us know if you're interested in contributing!
38+
- [ ] Yes, I can contribute
39+
- [ ] No, but I'm available for testing
40+
- [ ] No
41+
-->

‎.github/ISSUE_TEMPLATE/SUPPORT.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Support Request
3+
about: Support request or question about OME
4+
title: "[SUPPORT] "
5+
labels: kind/support
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
STOP!
12+
13+
For questions or support, please consider:
14+
15+
1. Searching existing issues: https://github.com/sgl-project/ome/issues
16+
2. Checking the documentation: https://docs.sglang.ai/ome/docs/
17+
3. Looking at examples in the /config/samples directory
18+
19+
If you still need help, please provide the following information:
20+
-->
21+
22+
## Question
23+
24+
<!-- Your question or support request here -->
25+
26+
## What did you try?
27+
28+
<!-- Describe what you've tried so far -->
29+
30+
## Environment
31+
32+
- OME version:
33+
- Kubernetes version:
34+
- Runtime being used (SGLang etc.):
35+
- Model being served (if applicable):
36+
37+
## Additional context
38+
39+
<!-- Add any other context or screenshots about the support request here. -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!--
2+
Thank you for contributing to OME! Please read the contributing guidelines:
3+
https://github.com/sgl-project/ome/blob/main/CONTRIBUTING.md
4+
-->
5+
6+
## What type of PR is this?
7+
8+
<!--
9+
Add one of the following:
10+
/kind bug
11+
/kind cleanup
12+
/kind documentation
13+
/kind feature
14+
/kind design
15+
-->
16+
17+
## What this PR does / why we need it:
18+
19+
<!--
20+
Please include a summary of the changes and which issue is fixed.
21+
Include relevant motivation and context.
22+
-->
23+
24+
## Which issue(s) this PR fixes:
25+
26+
<!--
27+
Automatically closes linked issue when PR is merged.
28+
Usage: Fixes #<issue number>, or Fixes (paste link of issue).
29+
-->
30+
Fixes #
31+
32+
## Special notes for your reviewer:
33+
34+
<!--
35+
Any specific areas you'd like reviewed? Any concerns?
36+
-->
37+
38+
## Does this PR introduce a user-facing change?
39+
40+
<!--
41+
If no, just write "NONE" in the release-note block below.
42+
If yes, a release note is required:
43+
Enter your extended release note in the block below. If the PR requires additional action from users switching to the new release, include the string "action required".
44+
-->
45+
46+
```release-note
47+
48+
```

‎.github/dependabot.yml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
version: 2
2+
updates:
3+
# Main Go module
4+
- package-ecosystem: "gomod"
5+
directory: "/"
6+
schedule:
7+
interval: "weekly"
8+
day: "saturday"
9+
labels:
10+
- "dependencies"
11+
- "go"
12+
groups:
13+
k8s:
14+
patterns:
15+
- "k8s.io/*"
16+
- "sigs.k8s.io/*"
17+
prometheus:
18+
patterns:
19+
- "github.com/prometheus/*"
20+
ignore:
21+
# Ignore major/minor K8s updates to maintain compatibility
22+
- dependency-name: "k8s.io/*"
23+
update-types: ["version-update:semver-major", "version-update:semver-minor"]
24+
- dependency-name: "sigs.k8s.io/*"
25+
update-types: ["version-update:semver-major", "version-update:semver-minor"]
26+
27+
# Tools Go module
28+
- package-ecosystem: "gomod"
29+
directory: "/hack/internal/tools"
30+
schedule:
31+
interval: "weekly"
32+
day: "saturday"
33+
labels:
34+
- "dependencies"
35+
- "go"
36+
- "tools"
37+
38+
# Site Go module (Hugo/Docsy)
39+
- package-ecosystem: "gomod"
40+
directory: "/site"
41+
schedule:
42+
interval: "weekly"
43+
day: "saturday"
44+
labels:
45+
- "dependencies"
46+
- "documentation"
47+
48+
# NPM dependencies for documentation site
49+
- package-ecosystem: "npm"
50+
directory: "/site"
51+
schedule:
52+
interval: "weekly"
53+
day: "saturday"
54+
labels:
55+
- "dependencies"
56+
- "documentation"
57+
- "javascript"
58+
59+
# GitHub Actions
60+
- package-ecosystem: "github-actions"
61+
directory: "/"
62+
schedule:
63+
interval: "weekly"
64+
day: "saturday"
65+
labels:
66+
- "dependencies"
67+
- "github-actions"
68+
69+
# Docker dependencies
70+
- package-ecosystem: "docker"
71+
directory: "/dockerfiles"
72+
schedule:
73+
interval: "weekly"
74+
day: "saturday"
75+
labels:
76+
- "dependencies"
77+
- "docker"

‎.github/workflows/openvex.yaml‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: Generate OpenVEX
2+
3+
on:
4+
release:
5+
types: [published]
6+
workflow_dispatch:
7+
inputs:
8+
tag:
9+
description: 'Tag to generate OpenVEX for'
10+
required: true
11+
type: string
12+
13+
permissions:
14+
contents: write
15+
security-events: write
16+
17+
jobs:
18+
generate-vex:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout code
22+
uses: actions/checkout@v4
23+
with:
24+
ref: ${{ github.event.release.tag_name || inputs.tag }}
25+
fetch-depth: 0
26+
27+
- name: Setup Go
28+
uses: actions/setup-go@v5
29+
with:
30+
go-version: '1.24.1'
31+
32+
- name: Install vexctl
33+
run: |
34+
go install github.com/openvex/vexctl@latest
35+
36+
- name: Run Trivy scan
37+
uses: aquasecurity/trivy-action@master
38+
with:
39+
scan-type: 'fs'
40+
scan-ref: '.'
41+
format: 'json'
42+
output: 'trivy-results.json'
43+
44+
- name: Generate VEX document
45+
run: |
46+
TAG="${{ github.event.release.tag_name || inputs.tag }}"
47+
48+
# Create VEX document for known false positives or accepted risks
49+
vexctl create \
50+
--author="OME Maintainers" \
51+
--role="Project Maintainer" \
52+
--product="pkg:github/sgl-project/ome@${TAG}" \
53+
--file="ome-${TAG}.vex.json"
54+
55+
# Note: You would add statements here for any false positives
56+
# Example:
57+
# vexctl add \
58+
# --file="ome-${TAG}.vex.json" \
59+
# --vuln="CVE-2023-12345" \
60+
# --status="not_affected" \
61+
# --justification="vulnerable_code_not_in_execute_path"
62+
63+
- name: Upload VEX to release
64+
if: github.event_name == 'release'
65+
uses: softprops/action-gh-release@v1
66+
with:
67+
files: |
68+
ome-*.vex.json
69+
70+
- name: Upload VEX as artifact
71+
uses: actions/upload-artifact@v4
72+
with:
73+
name: vex-${{ github.event.release.tag_name || inputs.tag }}
74+
path: |
75+
ome-*.vex.json

‎.github/workflows/pages.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ jobs:
4545

4646
- name: Install Hugo
4747
run: |
48-
cd hack/internal/tools && GOBIN=$GITHUB_WORKSPACE/bin CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@v0.142.0
48+
cd hack/internal/tools && GOBIN=$GITHUB_WORKSPACE/bin CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@v0.147.7
4949
echo "$GITHUB_WORKSPACE/bin" >> $GITHUB_PATH
5050
5151
- name: Install dependencies
@@ -59,7 +59,7 @@ jobs:
5959
HUGO_BASEURL: https://docs.sglang.ai/ome/
6060
run: |
6161
# Build the site with local node_modules
62-
$GITHUB_WORKSPACE/bin/hugo --baseURL https://docs.sglang.ai/ome/
62+
$GITHUB_WORKSPACE/bin/hugo --gc --minify --baseURL https://docs.sglang.ai/ome/
6363
6464
- name: Setup Pages
6565
uses: actions/configure-pages@v4

0 commit comments

Comments
 (0)