mirror of
https://github.com/tauri-apps/tauri.git
synced 2024-12-21 01:32:03 +03:00
69 lines
2.1 KiB
YAML
69 lines
2.1 KiB
YAML
# Copyright 2019-2021 Tauri Programme within The Commons Conservancy
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
# SPDX-License-Identifier: MIT
|
|
|
|
name: update-docs
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
inputs:
|
|
gitName:
|
|
description: "git name for PR"
|
|
required: false
|
|
default: "tauri-bot"
|
|
gitEmail:
|
|
description: "git email for PR"
|
|
required: false
|
|
default: "tauri-bot@tauri.studio"
|
|
|
|
jobs:
|
|
update-docs:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: checkout tauri
|
|
uses: actions/checkout@v2
|
|
with:
|
|
path: tauri
|
|
- name: checkout tauri-docs
|
|
uses: actions/checkout@v2
|
|
with:
|
|
repository: tauri-apps/tauri-docs
|
|
path: tauri-docs
|
|
- name: install webkit2gtk
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get install -y webkit2gtk-4.0
|
|
- name: generate rust docs
|
|
working-directory: ./tauri/core/tauri
|
|
run: cargo doc --no-deps
|
|
- name: run rustdocusaurus
|
|
uses: tauri-apps/typedocusaurus@v1
|
|
with:
|
|
originPath: ./tauri/target/doc/
|
|
targetPath: ./tauri-docs/docs/en/api/rust/
|
|
sidebarPath: ./tauri-docs/sidebars.json
|
|
linksRoot: /docs/api/rust/
|
|
cratesToProcess: "tauri"
|
|
- name: run typedocusaurus
|
|
uses: tauri-apps/typedocusaurus/github-action@v1
|
|
with:
|
|
originPath: ./tauri/tooling/api/
|
|
sidebarFile: sidebars.json
|
|
targetPath: en/api/js
|
|
docusaurusPath: ./tauri-docs/
|
|
- name: git config
|
|
run: |
|
|
git config --global user.name "${{ github.event.inputs.gitName }}"
|
|
git config --global user.email "${{ github.event.inputs.gitEmail }}"
|
|
- name: create pull request for updated docs
|
|
uses: tauri-apps/create-pull-request@v3.4.1
|
|
with:
|
|
token: ${{ secrets.TAURI_BOT_PAT }}
|
|
commit-message: "chore(docs): Update Rust & TS docs"
|
|
branch: docs/release
|
|
path: tauri-docs
|
|
title: Update Docs
|
|
labels: "new release"
|
|
body: |
|
|
These are the updated docs from the most recent release.
|