feat: bootstrap documentation site (#252)

Signed-off-by: Aaron <29749331+aarnphm@users.noreply.github.com>
Signed-off-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com>
Signed-off-by: GutZuFusss <leon.ikinger@googlemail.com>
Co-authored-by: GutZuFusss <leon.ikinger@googlemail.com>
This commit is contained in:
Aaron Pham
2023-09-12 12:28:29 -04:00
committed by GitHub
parent 7d128b8959
commit fddd0bf95e
115 changed files with 9118 additions and 3822 deletions

1
.github/INFRA.md vendored
View File

@@ -7,6 +7,7 @@
OpenLLM uses a GitHub Action to run all CI/CD workflows. It also use [pre-commit.ci](https://pre-commit.ci/) to run CI for all pre-commit hooks.
The folder structure of this are as follow:
```prolog
.
├── CODEOWNERS # Code owners

View File

@@ -3,22 +3,22 @@ on:
workflow_dispatch:
push:
branches:
- "main"
- 'main'
tags:
- "*"
- '*'
paths:
- ".github/workflows/build-embedding.yml"
- "openllm-python/src/openllm/**"
- "openllm-core/src/openllm_core/**"
- "openllm-client/src/openllm_client/**"
- '.github/workflows/build-embedding.yml'
- 'openllm-python/src/openllm/**'
- 'openllm-core/src/openllm_core/**'
- 'openllm-client/src/openllm_client/**'
pull_request:
branches:
- "main"
- 'main'
paths:
- ".github/workflows/build-embedding.yml"
- "openllm-python/src/openllm/**"
- "openllm-core/src/openllm_core/**"
- "openllm-client/src/openllm_client/**"
- '.github/workflows/build-embedding.yml'
- 'openllm-python/src/openllm/**'
- 'openllm-core/src/openllm_core/**'
- 'openllm-client/src/openllm_client/**'
types: [labeled, opened, synchronize, reopened]
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#defaultsrun
defaults:
@@ -188,7 +188,7 @@ jobs:
- name: Sign the released image
if: ${{ github.event_name != 'pull_request' }}
env:
COSIGN_EXPERIMENTAL: "true"
COSIGN_EXPERIMENTAL: 'true'
run: echo "${{ steps.meta.outputs.tags }}" | xargs -I {} cosign sign --yes {}@${{ steps.build-and-push.outputs.digest }}
- name: Run Trivy in GitHub SBOM mode and submit results to Dependency Graph
uses: aquasecurity/trivy-action@fbd16365eb88e12433951383f5e99bd901fc618f # ratchet:aquasecurity/trivy-action@master

View File

@@ -3,22 +3,22 @@ on:
workflow_dispatch:
push:
branches:
- "main"
- 'main'
tags:
- "*"
- '*'
paths:
- ".github/workflows/build-embedding.yml"
- "openllm-python/src/openllm/**"
- "openllm-core/src/openllm_core/**"
- "openllm-client/src/openllm_client/**"
- '.github/workflows/build-embedding.yml'
- 'openllm-python/src/openllm/**'
- 'openllm-core/src/openllm_core/**'
- 'openllm-client/src/openllm_client/**'
pull_request:
branches:
- "main"
- 'main'
paths:
- ".github/workflows/build-embedding.yml"
- "openllm-python/src/openllm/**"
- "openllm-core/src/openllm_core/**"
- "openllm-client/src/openllm_client/**"
- '.github/workflows/build-embedding.yml'
- 'openllm-python/src/openllm/**'
- 'openllm-core/src/openllm_core/**'
- 'openllm-client/src/openllm_client/**'
types: [labeled, opened, synchronize, reopened]
env:
LINES: 120
@@ -184,7 +184,7 @@ jobs:
- name: Sign the released image
if: ${{ github.event_name != 'pull_request' }}
env:
COSIGN_EXPERIMENTAL: "true"
COSIGN_EXPERIMENTAL: 'true'
run: echo "${{ steps.meta.outputs.tags }}" | xargs -I {} cosign sign --yes {}@${{ steps.build-and-push.outputs.digest }}
- name: Run Trivy in GitHub SBOM mode and submit results to Dependency Graph
uses: aquasecurity/trivy-action@fbd16365eb88e12433951383f5e99bd901fc618f # ratchet:aquasecurity/trivy-action@master

View File

@@ -4,16 +4,16 @@ on:
push:
branches: [main]
tags:
- "*"
- '*'
paths:
- 'openllm-contrib/clojure/**'
- ".github/workflows/clojure-frontend.yml"
- 'contrib/clojure/**'
- '.github/workflows/clojure-frontend.yml'
pull_request:
types: [labeled, opened, synchronize, reopened]
branches: [main]
paths:
- 'openllm-contrib/clojure/**'
- ".github/workflows/clojure-frontend.yml"
- 'contrib/clojure/**'
- '.github/workflows/clojure-frontend.yml'
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#defaultsrun
defaults:
run:
@@ -114,7 +114,7 @@ jobs:
- name: Sign the released image
if: ${{ github.event_name != 'pull_request' }}
env:
COSIGN_EXPERIMENTAL: "true"
COSIGN_EXPERIMENTAL: 'true'
run: echo "${{ steps.meta.outputs.tags }}" | xargs -I {} cosign sign --yes {}@${{ steps.build-and-push.outputs.digest }}
- name: Run Trivy in GitHub SBOM mode and submit results to Dependency Graph
uses: aquasecurity/trivy-action@fbd16365eb88e12433951383f5e99bd901fc618f # ratchet:aquasecurity/trivy-action@master

View File

@@ -13,7 +13,7 @@ on:
type: string
outputs:
sucess:
description: "Whether the build is successful or not"
description: 'Whether the build is successful or not'
value: ${{ jobs.sucess-build.outputs.success }}
push:
branches: [main]
@@ -74,7 +74,7 @@ jobs:
strategy:
fail-fast: false
matrix:
directory: ["openllm-core", "openllm-python", "openllm-client"]
directory: ['openllm-core', 'openllm-python', 'openllm-client']
steps:
- uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # ratchet:actions/checkout@v4
with:
@@ -105,11 +105,11 @@ jobs:
# Github Actions doesn't support pairing matrix values together, let's improvise
# https://github.com/github/feedback/discussions/7835#discussioncomment-1769026
buildplatform:
- [ubuntu-latest, linux-x86_64, ""]
- [macos-latest, macos-x86_64, "x86_64"]
- [macos-latest, macos-arm64, "arm64"]
- [macos-latest, macos-universal2, "universal2"]
directory: ["openllm-core", "openllm-python", "openllm-client"]
- [ubuntu-latest, linux-x86_64, '']
- [macos-latest, macos-x86_64, 'x86_64']
- [macos-latest, macos-arm64, 'arm64']
- [macos-latest, macos-universal2, 'universal2']
directory: ['openllm-core', 'openllm-python', 'openllm-client']
needs: get_commit_message
steps:
- uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # ratchet:actions/checkout@v4
@@ -127,7 +127,7 @@ jobs:
config-file: pyproject.toml
env:
CIBW_PRERELEASE_PYTHONS: True
CIBW_ARCHS_MACOS: "${{ matrix.buildplatform[2] }}"
CIBW_ARCHS_MACOS: '${{ matrix.buildplatform[2] }}'
MYPYPATH: /project/typings
- name: Upload wheels as workflow artifacts
uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # ratchet:actions/upload-artifact@v3

View File

@@ -8,7 +8,7 @@ on:
# │ │ │ ┌───────────── month (1 - 12 or JAN-DEC)
# │ │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
# │ │ │ │ │
- cron: "42 2 * * SUN-WED"
- cron: '42 2 * * SUN-WED'
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#defaultsrun
defaults:
run:
@@ -49,8 +49,8 @@ jobs:
GIT_COMMITTER_EMAIL: ${{ steps.import-gpg-key.outputs.email }}
BRANCH_NAME: cron/ratchet
with:
title: "ci: update lock actions [generated]"
commit-message: "cron: ratchet update"
title: 'ci: update lock actions [generated]'
commit-message: 'cron: ratchet update'
branch-suffix: timestamp
signoff: true
delete-branch: true