diff --git a/doc/assets/js/search.js b/doc/assets/js/search.js index fa9fdcd..537b91d 100644 --- a/doc/assets/js/search.js +++ b/doc/assets/js/search.js @@ -1 +1 @@ -window.searchData = {"kinds":{"128":"Class","512":"Constructor","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"default","url":"classes/default.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/default.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"default"},{"id":2,"kind":2048,"name":"github","url":"classes/default.html#github","classes":"tsd-kind-method tsd-parent-kind-class","parent":"default"},{"id":3,"kind":1024,"name":"client","url":"classes/default.html#client","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"default"},{"id":4,"kind":1024,"name":"inputs","url":"classes/default.html#inputs","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"default"},{"id":5,"kind":2048,"name":"__getBasePath","url":"classes/default.html#__getbasepath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"default"},{"id":6,"kind":2048,"name":"__doc","url":"classes/default.html#__doc","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"default"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,0.645]],["parent/0",[]],["name/1",[1,16.74]],["parent/1",[0,0.06]],["name/2",[2,16.74]],["parent/2",[0,0.06]],["name/3",[3,16.74]],["parent/3",[0,0.06]],["name/4",[4,16.74]],["parent/4",[0,0.06]],["name/5",[5,16.74]],["parent/5",[0,0.06]],["name/6",[6,16.74]],["parent/6",[0,0.06]]],"invertedIndex":[["__doc",{"_index":6,"name":{"6":{}},"parent":{}}],["__getbasepath",{"_index":5,"name":{"5":{}},"parent":{}}],["client",{"_index":3,"name":{"3":{}},"parent":{}}],["constructor",{"_index":1,"name":{"1":{}},"parent":{}}],["default",{"_index":0,"name":{"0":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{}}}],["github",{"_index":2,"name":{"2":{}},"parent":{}}],["inputs",{"_index":4,"name":{"4":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file +window.searchData = {"kinds":{"128":"Class","512":"Constructor","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":128,"name":"default","url":"classes/default.html","classes":"tsd-kind-class"},{"id":1,"kind":512,"name":"constructor","url":"classes/default.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"default"},{"id":2,"kind":2048,"name":"index","url":"classes/default.html#index","classes":"tsd-kind-method tsd-parent-kind-class","parent":"default"},{"id":3,"kind":2048,"name":"github","url":"classes/default.html#github","classes":"tsd-kind-method tsd-parent-kind-class","parent":"default"},{"id":4,"kind":1024,"name":"client","url":"classes/default.html#client","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"default"},{"id":5,"kind":1024,"name":"inputs","url":"classes/default.html#inputs","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected","parent":"default"},{"id":6,"kind":2048,"name":"__getBasePath","url":"classes/default.html#__getbasepath","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"default"},{"id":7,"kind":2048,"name":"__doc","url":"classes/default.html#__doc","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"default"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,0.572]],["parent/0",[]],["name/1",[1,17.918]],["parent/1",[0,0.054]],["name/2",[2,17.918]],["parent/2",[0,0.054]],["name/3",[3,17.918]],["parent/3",[0,0.054]],["name/4",[4,17.918]],["parent/4",[0,0.054]],["name/5",[5,17.918]],["parent/5",[0,0.054]],["name/6",[6,17.918]],["parent/6",[0,0.054]],["name/7",[7,17.918]],["parent/7",[0,0.054]]],"invertedIndex":[["__doc",{"_index":7,"name":{"7":{}},"parent":{}}],["__getbasepath",{"_index":6,"name":{"6":{}},"parent":{}}],["client",{"_index":4,"name":{"4":{}},"parent":{}}],["constructor",{"_index":1,"name":{"1":{}},"parent":{}}],["default",{"_index":0,"name":{"0":{}},"parent":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}}}],["github",{"_index":3,"name":{"3":{}},"parent":{}}],["index",{"_index":2,"name":{"2":{}},"parent":{}}],["inputs",{"_index":5,"name":{"5":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file diff --git a/doc/classes/default.html b/doc/classes/default.html index df133a8..fea6b51 100644 --- a/doc/classes/default.html +++ b/doc/classes/default.html @@ -101,6 +101,7 @@

Methods

  • __doc
  • __getBasePath
  • github
  • +
  • index
  • @@ -119,7 +120,7 @@

    constructor

    Parameters

    @@ -142,7 +143,7 @@

    Protected client

    @@ -168,7 +169,7 @@

    __doc

    Parameters

    @@ -192,7 +193,7 @@

    __getBasePath

    Returns string

    @@ -209,7 +210,7 @@

    github

  • @@ -227,6 +228,34 @@

    Returns Promise +
    + +

    index

    +
      +
    • index(inputs: InputProps): Promise<void>
    • +
    +
      +
    • + +
      +
      +

      交互式获取CI/CD解决方案(默认方法)

      +
      +
      +

      Parameters

      +
        +
      • +
        inputs: InputProps
        +
      • +
      +

      Returns Promise<void>

      +
    • +
    +

  • +
  • + index +
  • diff --git a/doc/doc.json b/doc/doc.json index 11ee029..73fb2c7 100644 --- a/doc/doc.json +++ b/doc/doc.json @@ -56,7 +56,7 @@ } }, { - "id": 8, + "id": 11, "name": "client", "kind": 1024, "kindString": "Property", @@ -80,7 +80,7 @@ } }, { - "id": 9, + "id": 12, "name": "inputs", "kind": 1024, "kindString": "Property", @@ -97,7 +97,7 @@ } }, { - "id": 12, + "id": 15, "name": "__doc", "kind": 2048, "kindString": "Method", @@ -111,14 +111,14 @@ ], "signatures": [ { - "id": 13, + "id": 16, "name": "__doc", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 14, + "id": 17, "name": "projectName", "kind": 32768, "kindString": "Parameter", @@ -147,7 +147,7 @@ } }, { - "id": 10, + "id": 13, "name": "__getBasePath", "kind": 2048, "kindString": "Method", @@ -161,7 +161,7 @@ ], "signatures": [ { - "id": 11, + "id": 14, "name": "__getBasePath", "kind": 4096, "kindString": "Call signature", @@ -182,7 +182,7 @@ } }, { - "id": 5, + "id": 8, "name": "github", "kind": 2048, "kindString": "Method", @@ -192,13 +192,13 @@ "sources": [ { "fileName": "index.ts", - "line": 25, + "line": 47, "character": 23 } ], "signatures": [ { - "id": 6, + "id": 9, "name": "github", "kind": 4096, "kindString": "Call signature", @@ -207,6 +207,59 @@ "shortText": "创建Github Action模板", "returns": "\n" }, + "parameters": [ + { + "id": 10, + "name": "inputs", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": {}, + "type": { + "type": "reference", + "name": "InputProps" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise" + } + } + ] + }, + { + "id": 5, + "name": "index", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "index.ts", + "line": 26, + "character": 22 + } + ], + "signatures": [ + { + "id": 6, + "name": "index", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "交互式获取CI/CD解决方案(默认方法)", + "returns": "\n" + }, "parameters": [ { "id": 7, @@ -247,16 +300,17 @@ "title": "Properties", "kind": 1024, "children": [ - 8, - 9 + 11, + 12 ] }, { "title": "Methods", "kind": 2048, "children": [ - 12, - 10, + 15, + 13, + 8, 5 ] } @@ -264,7 +318,7 @@ "sources": [ { "fileName": "index.ts", - "line": 15, + "line": 16, "character": 34 } ], diff --git a/doc/index.html b/doc/index.html index 6e6780a..96935f3 100644 --- a/doc/index.html +++ b/doc/index.html @@ -61,21 +61,44 @@

    cicd

    组件说明

    - -

    使用场景

    +

    通过该组件,可以快速帮助使用者创建CI/CD模板,或提供对应的CI/CD解决方案

    +
    +

    所支持的平台

    - -

    具体用法

    -
    - -

    s cli 方式

    -
    -
    s cli <componentname> -d
    -
    - -

    应用编排使用方式

    -
    -

    查看 example下 s.yaml

    + +
    +

    设计文档:Design-Documentation.md

    +
    +

    目前CI/CD方案正在建设中,欢迎大家提供相对应的方案:

    + +