pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-04-26 01:47:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Script for publishing rustdocs at gh-pages (#10604)

Browse Source 
* wip

Signed-off-by: Jimmy Chu <jimmychu0807@gmail.com>

* Added the rustdocs-release script

Signed-off-by: Jimmy Chu <jimmychu0807@gmail.com>

* updated gitlab-ci script

Signed-off-by: Jimmy Chu <jimmychu0807@gmail.com>

* Updated to set NIGHTLY to false by default

Signed-off-by: Jimmy Chu <jimmychu0807@gmail.com>

* Added documentation

Signed-off-by: Jimmy Chu <jimmychu0807@gmail.com>
This commit is contained in:
Jimmy Chu
2022-01-22 01:32:45 +08:00
committed by GitHub
parent 4880741eaa
commit 39d5c357af
3 changed files with 269 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/docs/rustdocs-release.md
+20
View File
@@ -0,0 +1,20 @@
# Rustdocs Release Process
There is [a script in place](../.maintain/rustdocs-release.sh) to manage the deployment of Substrate rustdocs at
https://paritytech.github.io/substrate, which is pushing the rustdocs file in `gh-pages` branch of
https://github.com/paritytech/substrate.
The documentation at the top of the `rustdocs-release.sh` explains most of the mechanics of the script.
Manage the rustdocs deployment with one of the following commands.
```bash
# Deploy rustdocs of `monthly-2021-10` tag
.maintain/rustdocs-release.sh deploy monthly-2021-10
# In addition to the above, the `latest` symlink will point to this version of rustdocs
.maintain/rustdocs-release.sh deploy -l monthly-2021-10
# Remove the rustdocs of `monthly-2021-10` from `gh-pages`.
.maintain/rustdocs-release.sh remove monthly-2021-10
```