mirror of
https://github.com/asterinas/asterinas.git
synced 2025-06-23 09:23:25 +00:00
Remove publish api docs CI
This commit is contained in:
committed by
Tate, Hongliang Tian
parent
f86583dbce
commit
3462da986e
43
.github/workflows/publish_api_docs.yml
vendored
43
.github/workflows/publish_api_docs.yml
vendored
@ -1,43 +0,0 @@
|
|||||||
name: Update API docs
|
|
||||||
|
|
||||||
on:
|
|
||||||
# Scheduled events for nightly API docs
|
|
||||||
schedule:
|
|
||||||
# UTC 00:00 everyday
|
|
||||||
- cron: "0 0 * * *"
|
|
||||||
# Events for API docs of new release
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
paths:
|
|
||||||
- VERSION
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build_and_upload:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
timeout-minutes: 15
|
|
||||||
container: asterinas/asterinas:0.6.2
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v2
|
|
||||||
with:
|
|
||||||
repository: 'asterinas/asterinas'
|
|
||||||
path: 'asterinas'
|
|
||||||
|
|
||||||
- name: Build & Upload Nightly API Docs
|
|
||||||
if: github.event_name == 'schedule'
|
|
||||||
env:
|
|
||||||
API_DOCS_NIGHTLY_PUBLISH_KEY: ${{ secrets.API_DOCS_NIGHTLY_PUBLISH_KEY }}
|
|
||||||
run: |
|
|
||||||
KEY_FILE=./api_docs_nightly_publish_key
|
|
||||||
echo "$API_DOCS_NIGHTLY_PUBLISH_KEY\n" > ${KEY_FILE}
|
|
||||||
bash asterinas/tools/github_workflows/build_and_upload_api_docs.sh nightly ${KEY_FILE}
|
|
||||||
|
|
||||||
- name: Build & Upload Release API Docs
|
|
||||||
if: github.event_name == 'push'
|
|
||||||
env:
|
|
||||||
API_DOCS_PUBLISH_KEY: ${{ secrets.API_DOCS_PUBLISH_KEY }}
|
|
||||||
run: |
|
|
||||||
KEY_FILE=./api_docs_publish_key
|
|
||||||
echo "$API_DOCS_PUBLISH_KEY\n" > ${KEY_FILE}
|
|
||||||
bash asterinas/tools/github_workflows/build_and_upload_api_docs.sh release ${KEY_FILE}
|
|
@ -39,9 +39,7 @@ To explore how these APIs come into play,
|
|||||||
see [the example of a 100-line kernel in safe Rust](a-100-line-kernel.md).
|
see [the example of a 100-line kernel in safe Rust](a-100-line-kernel.md).
|
||||||
|
|
||||||
The OSTD APIs have been extensively documented.
|
The OSTD APIs have been extensively documented.
|
||||||
You can access the comprehensive API documentation for each release by visiting the [API docs](https://asterinas.github.io/api-docs).
|
You can access the comprehensive API documentation by visiting the [docs.rs](https://docs.rs/ostd/latest/ostd).
|
||||||
Additionally, you can refer to the latest nightly version API documentation at [API docs nightly](https://asterinas.github.io/api-docs-nightly),
|
|
||||||
which remains in sync with the latest changes in the main branch.
|
|
||||||
|
|
||||||
## Four Requirements Satisfied
|
## Four Requirements Satisfied
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user