Skip to content

Commit

Permalink
ci: add doc deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
Randoooom committed Jan 4, 2024
1 parent b0c4189 commit eb7ad4b
Show file tree
Hide file tree
Showing 4 changed files with 186 additions and 8 deletions.
5 changes: 0 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@ name: Continuous integration

on:
workflow_dispatch:
push:
branches:
- main
paths:
- "**.rs"
pull_request:
merge_group:

Expand Down
183 changes: 183 additions & 0 deletions .github/workflows/nightly.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
name: Continuous integration

on:
workflow_dispatch:
push:
branches:
- main

jobs:
check:
name: check
runs-on: ubuntu-latest
steps:
- name: Install toolchain
uses: actions-rs/toolchain@v1
with:
toolchain: nightly
override: true

- name: Checkout Sources
uses: actions/checkout@v3

- name: Setup cache
uses: Swatinem/rust-cache@v2

- name: Install cargo-make
uses: actions-rs/cargo@v1
with:
command: install
args: cargo-make

- name: Run check
run: cargo make check

clippy:
name: clippy
runs-on: ubuntu-latest
steps:
- name: Install toolchain
uses: actions-rs/toolchain@v1
with:
toolchain: nightly
override: true
components: clippy
profile: minimal

- name: Checkout Sources
uses: actions/checkout@v3

- name: Setup cache
uses: Swatinem/rust-cache@v2

- name: Install cargo-make
uses: actions-rs/cargo@v1
with:
command: install
args: cargo-make

- name: Run clippy
run: cargo make clippy

test:
needs: [ clippy, check ]
name: tests
runs-on: ubuntu-latest
steps:
- name: Install toolchain
uses: actions-rs/toolchain@v1
with:
toolchain: nightly
override: true
profile: minimal

- name: Checkout Sources
uses: actions/checkout@v3

- name: Setup cache
uses: Swatinem/rust-cache@v2

- name: Install cargo-make
uses: actions-rs/cargo@v1
with:
command: install
args: cargo-make

- name: Tests
run: cargo make test

docs-lint:
name: lint docs
runs-on: ubuntu-latest
steps:
- uses: pnpm/action-setup@v2
with:
version: 8

- name: Install toolchain
uses: actions-rs/toolchain@v1
with:
toolchain: nightly
override: true

- name: Checkout Sources
uses: actions/checkout@v3

- name: Setup cache
uses: Swatinem/rust-cache@v2

- name: Install cargo-make
uses: actions-rs/cargo@v1
with:
command: install
args: cargo-make

- name: Run docs lint
uses: actions-rs/cargo@v1
with:
command: make
args: docs_lint

build-docs:
name: build docs
runs-on: ubuntu-latest
steps:
- uses: pnpm/action-setup@v2
with:
version: 8

- name: Install toolchain
uses: actions-rs/toolchain@v1
with:
toolchain: nightly
override: true

- name: Checkout Sources
uses: actions/checkout@v3

- name: Setup cache
uses: Swatinem/rust-cache@v2

- name: Install cargo-make
uses: actions-rs/cargo@v1
with:
command: install
args: cargo-make

- name: Build docs
uses: actions-rs/cargo@v1
with:
command: make
args: docs_build

- name: Archive artifact
run: |
tar \
--dereference --hard-dereference \
-cvf "$RUNNER_TEMP/pages.tar" \
docs/

- name: Upload artifact
id: upload-artifact
uses: actions/upload-artifact@v4
with:
name: pages
path: ${{ runner.temp }}/pages.tar
retention-days: 1
if-no-files-found: error

deploy-docs:
needs: [build-docs]
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}/nightly
steps:
- name: Deploy to pages
id: deployment
uses: actions/deploy-pages@v4
with:
artifact_name: "pages"
2 changes: 1 addition & 1 deletion Makefile.toml
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ args = [
[tasks.docs_build]
dependencies = ["docs_lint"]
command = "npx"
args = ["redocly", "build-docs", "target/openapi.yaml", "-o", "docs/index.html"]
args = ["redocly", "build-docs", "target/openapi.yaml", "-o", "docs/rest/index.html"]

[tasks.generate_bindings]
command = "cargo"
Expand Down
4 changes: 2 additions & 2 deletions lib/core/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { SubmitFeedbackPromptResponseRequest, FeedbackPromptResponse } from "../../../bindings";


async function submitResponse(options: SubmitFeedbackPromptResponseRequest): Promise<FeedbackPromptResponse> {
export async function submitResponse(options: SubmitFeedbackPromptResponseRequest): Promise<FeedbackPromptResponse> {

}

export * from "../../../bindings";
Expand Down

0 comments on commit eb7ad4b

Please sign in to comment.