mirror of
https://github.com/swc-project/swc.git
synced 2024-09-21 05:39:06 +03:00
chore(ci): Configure github actions for rustdoc (#1523)
This commit is contained in:
parent
51d0cef287
commit
13a9d12c84
44
.github/workflows/cargo.yml
vendored
44
.github/workflows/cargo.yml
vendored
@ -196,13 +196,37 @@ jobs:
|
||||
jest -v
|
||||
cargo test --color always -p ${{ matrix.crate }}
|
||||
|
||||
# We use travis for rustdocs
|
||||
# deploy-docs:
|
||||
# runs-on: ubuntu-latest
|
||||
# if: github.ref == 'refs/heads/master'
|
||||
# needs:
|
||||
# - test
|
||||
# steps:
|
||||
# - uses: actions/checkout@v2
|
||||
# - name: Create rustdoc
|
||||
# run: cargo doc
|
||||
deploy-docs:
|
||||
name: Docs
|
||||
runs-on: ubuntu-latest
|
||||
# if: github.ref == 'refs/heads/master'
|
||||
# needs:
|
||||
# - test
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Install Rust
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
profile: minimal
|
||||
toolchain: nightly-2021-03-30
|
||||
|
||||
- name: Create rustdoc
|
||||
run: cargo +nightly-2021-03-30 doc
|
||||
|
||||
- name: Create CNAME
|
||||
run: |
|
||||
echo 'rustdoc.swc.rs' > target/doc/CNAME
|
||||
|
||||
- name: Deploy
|
||||
# if: github.ref == 'refs/heads/master'
|
||||
uses: JamesIves/github-pages-deploy-action@4.1.0
|
||||
with:
|
||||
token: ${{ secrets.GH_TOKEN }}
|
||||
branch: gh-pages
|
||||
folder: target/doc
|
||||
clean: true
|
||||
git-config-email: kdy1997.dev@gmail.com
|
||||
repository-name: swc-project/rustdoc
|
||||
commit-message: "Update"
|
||||
single-commit: true
|
||||
|
@ -143,9 +143,9 @@ Parser tests ensures that parsed result of test262/pass is identical with test26
|
||||
|
||||
Codegen tests ensures that generated code is equivalent to goldened reference files located at [tests/references](ecmascript/codegen/tests/references).
|
||||
|
||||
[enum_kind]: https://swc.rs/rustdoc/enum_kind/derive.Kind.html
|
||||
[string_enum]: https://swc.rs/rustdoc/string_enum/derive.StringEnum.html
|
||||
[ast_node]: https://swc.rs/rustdoc/ast_node/index.html
|
||||
[parser_macros]: https://swc.rs/rustdoc/swc_ecma_parser_macros/index.html
|
||||
[codegen_macros]: https://swc.rs/rustdoc/swc_ecma_codegen_macros/index.html
|
||||
[enum_kind]: https://rustdoc.swc.rs/enum_kind/derive.Kind.html
|
||||
[string_enum]: https://rustdoc.swc.rs/string_enum/derive.StringEnum.html
|
||||
[ast_node]: https://rustdoc.swc.rs/ast_node/index.html
|
||||
[parser_macros]: https://rustdoc.swc.rs/swc_ecma_parser_macros/index.html
|
||||
[codegen_macros]: https://rustdoc.swc.rs/swc_ecma_codegen_macros/index.html
|
||||
[test262]: https://github.com/tc39/test262
|
||||
|
@ -6,7 +6,7 @@ members = ["ecmascript", "ecmascript/jsdoc", "native", "spack", "wasm"]
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Speedy web compiler"
|
||||
documentation = "https://swc.rs/rustdoc/swc/"
|
||||
documentation = "https://rustdoc.swc.rs/swc/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc"
|
||||
|
@ -2,7 +2,7 @@
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
build = "build.rs"
|
||||
description = "Atoms for the swc project."
|
||||
documentation = "https://swc.rs/rustdoc/swc_atoms/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_atoms/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_atoms"
|
||||
|
@ -3,7 +3,7 @@ authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
# OUT_DIR is required for testing
|
||||
build = "build.rs"
|
||||
description = "Very fast ecmascript bundler"
|
||||
documentation = "https://swc.rs/rustdoc/swc_bundler/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_bundler/"
|
||||
edition = "2018"
|
||||
include = ["Cargo.toml", "build.rs", "src/**/*.rs", "src/**/*.js"]
|
||||
license = "Apache-2.0/MIT"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Common utilities for the swc project."
|
||||
documentation = "https://swc.rs/rustdoc/swc_common/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_common/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_common"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Ecmascript"
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecmascript/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecmascript/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecmascript"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Ecmascript ast."
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_ast/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_ast/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_ast"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Ecmascript code generator for the swc project."
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_codegen/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_codegen/"
|
||||
edition = "2018"
|
||||
include = ["Cargo.toml", "src/**/*.rs"]
|
||||
license = "Apache-2.0/MIT"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Macros for swc_ecma_codegen."
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_codegen_macros/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_codegen_macros/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_codegen_macros"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Dependency graph for the ecmascript"
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_dep_graph/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_dep_graph/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_dep_graph"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Extensions for @swc/core (nodejs)"
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_ext_transforms/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_ext_transforms/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_ext_transforms"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "JsDoc parser writen in rust"
|
||||
documentation = "https://swc.rs/rustdoc/jsdoc/"
|
||||
documentation = "https://rustdoc.swc.rs/jsdoc/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "jsdoc"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "General ecmascript loader used for transforms"
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_loader/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_loader/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_loader"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Feature-complete es2019 parser."
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_parser/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_parser/"
|
||||
edition = "2018"
|
||||
include = ["Cargo.toml", "src/**/*.rs", "examples/**/*.rs"]
|
||||
license = "Apache-2.0/MIT"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "preset-env for the swc"
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_preset_env/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_preset_env/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_preset_env"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "rust port of babel and closure compiler."
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_transforms/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_transforms/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_transforms"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "rust port of babel and closure compiler."
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_transforms_base/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_transforms_base/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_transforms_base"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "rust port of babel and closure compiler."
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_transforms_compat/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_transforms_compat/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_transforms_compat"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Macros for swc_ecma_transforms."
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_transforms_macros/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_transforms_macros/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_transforms_macros"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "rust port of babel and closure compiler."
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_transforms_optimization/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_transforms_optimization/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_transforms_module"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "rust port of babel and closure compiler."
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_transforms_optimization/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_transforms_optimization/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_transforms_optimization"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "rust port of babel and closure compiler."
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_transforms_proposal/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_transforms_proposal/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_transforms_proposal"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "rust port of babel and closure compiler."
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_transforms_react/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_transforms_react/"
|
||||
edition = "2018"
|
||||
include = ["Cargo.toml", "src/**/*.rs"]
|
||||
license = "Apache-2.0/MIT"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "rust port of babel and closure compiler."
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_transforms_testing/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_transforms_testing/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_transforms_testing"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "rust port of babel and closure compiler."
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_transforms_typescript/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_transforms_typescript/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_transforms_typescript"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Utilities for swc ecmascript ast nodes"
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_utils/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_utils/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_utils"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Visitors for swc ecmascript nodes which works on stable rustc"
|
||||
documentation = "https://swc.rs/rustdoc/swc_ecma_visit/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_ecma_visit/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_ecma_visit"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Macros for ast nodes."
|
||||
documentation = "https://swc.rs/rustdoc/ast_node/"
|
||||
documentation = "https://rustdoc.swc.rs/ast_node/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "ast_node"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Common utilities for swc macros."
|
||||
documentation = "https://swc.rs/rustdoc/swc_macros_common/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_macros_common/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_macros_common"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Easily manage values related to enum."
|
||||
documentation = "https://swc.rs/rustdoc/enum_kind/"
|
||||
documentation = "https://rustdoc.swc.rs/enum_kind/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "enum_kind"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1@dudy.kr>"]
|
||||
description = "Macros for EqIgnoreSpan and TypeEq."
|
||||
documentation = "https://swc.rs/rustdoc/swc_eq_ignore_macros/"
|
||||
documentation = "https://rustdoc.swc.rs/swc_eq_ignore_macros/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "swc_eq_ignore_macros"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Automatically derive From impls for enums"
|
||||
documentation = "https://swc.rs/rustdoc/from_variant/"
|
||||
documentation = "https://rustdoc.swc.rs/from_variant/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "from_variant"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "String based enum."
|
||||
documentation = "https://swc.rs/rustdoc/string_enum/"
|
||||
documentation = "https://rustdoc.swc.rs/string_enum/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "string_enum"
|
||||
|
@ -2,7 +2,7 @@
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
build = "build.rs"
|
||||
description = "Speedy web compiler"
|
||||
documentation = "https://swc.rs/rustdoc/swc/"
|
||||
documentation = "https://rustdoc.swc.rs/swc/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "spack"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "Testing utilities for the swc project."
|
||||
documentation = "https://swc.rs/rustdoc/testing/"
|
||||
documentation = "https://rustdoc.swc.rs/testing/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "testing"
|
||||
|
@ -1,7 +1,7 @@
|
||||
[package]
|
||||
authors = ["강동윤 <kdy1997.dev@gmail.com>"]
|
||||
description = "General purpose testing macros"
|
||||
documentation = "https://swc.rs/rustdoc/testing_macros/"
|
||||
documentation = "https://rustdoc.swc.rs/testing_macros/"
|
||||
edition = "2018"
|
||||
license = "Apache-2.0/MIT"
|
||||
name = "testing_macros"
|
||||
|
@ -1,3 +1,3 @@
|
||||
# testing_macros
|
||||
|
||||
Please refer to [rustdoc](https://swc.rs/rustdoc/testing_macros)
|
||||
Please refer to [rustdoc](https://rustdoc.swc.rs/testing_macros)
|
||||
|
Loading…
Reference in New Issue
Block a user