Skip to content

Commit

Permalink
add index
Browse files Browse the repository at this point in the history
  • Loading branch information
anycodes committed Jun 4, 2021
1 parent 03f494d commit 7357e55
Show file tree
Hide file tree
Showing 9 changed files with 211 additions and 39 deletions.
2 changes: 1 addition & 1 deletion doc/assets/js/search.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

42 changes: 37 additions & 5 deletions doc/classes/default.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ <h3>Methods</h3>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="default.html#__doc" class="tsd-kind-icon">__doc</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="default.html#__getbasepath" class="tsd-kind-icon">__get<wbr>Base<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#github" class="tsd-kind-icon">github</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#index" class="tsd-kind-icon">index</a></li>
</ul>
</section>
</div>
Expand All @@ -119,7 +120,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Overrides BaseComponent.constructor</p>
<ul>
<li>Defined in index.ts:15</li>
<li>Defined in <a href="https://github.com/Serverless-Devs/cicd/blob/03f494d/src/index.ts#L16">index.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -142,7 +143,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> client</h3>
<aside class="tsd-sources">
<p>Inherited from BaseComponent.client</p>
<ul>
<li>Defined in common/base.ts:9</li>
<li>Defined in <a href="https://github.com/Serverless-Devs/cicd/blob/03f494d/src/common/base.ts#L9">common/base.ts:9</a></li>
</ul>
</aside>
</section>
Expand All @@ -168,7 +169,7 @@ <h3>__doc</h3>
<aside class="tsd-sources">
<p>Inherited from BaseComponent.__doc</p>
<ul>
<li>Defined in common/base.ts:34</li>
<li>Defined in <a href="https://github.com/Serverless-Devs/cicd/blob/03f494d/src/common/base.ts#L34">common/base.ts:34</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -192,7 +193,7 @@ <h3>__get<wbr>Base<wbr>Path</h3>
<aside class="tsd-sources">
<p>Inherited from BaseComponent.__getBasePath</p>
<ul>
<li>Defined in common/base.ts:21</li>
<li>Defined in <a href="https://github.com/Serverless-Devs/cicd/blob/03f494d/src/common/base.ts#L21">common/base.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
Expand All @@ -209,7 +210,7 @@ <h3>github</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in index.ts:25</li>
<li>Defined in <a href="https://github.com/Serverless-Devs/cicd/blob/03f494d/src/index.ts#L47">index.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -227,6 +228,34 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="index" class="tsd-anchor"></a>
<h3>index</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">index<span class="tsd-signature-symbol">(</span>inputs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">InputProps</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Serverless-Devs/cicd/blob/03f494d/src/index.ts#L26">index.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>交互式获取CI/CD解决方案（默认方法）</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>inputs: <span class="tsd-signature-type">InputProps</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
Expand Down Expand Up @@ -262,6 +291,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="default.html#github" class="tsd-kind-icon">github</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="default.html#index" class="tsd-kind-icon">index</a>
</li>
</ul>
</li>
</ul>
Expand Down
84 changes: 69 additions & 15 deletions doc/doc.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
}
},
{
"id": 8,
"id": 11,
"name": "client",
"kind": 1024,
"kindString": "Property",
Expand All @@ -80,7 +80,7 @@
}
},
{
"id": 9,
"id": 12,
"name": "inputs",
"kind": 1024,
"kindString": "Property",
Expand All @@ -97,7 +97,7 @@
}
},
{
"id": 12,
"id": 15,
"name": "__doc",
"kind": 2048,
"kindString": "Method",
Expand All @@ -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",
Expand Down Expand Up @@ -147,7 +147,7 @@
}
},
{
"id": 10,
"id": 13,
"name": "__getBasePath",
"kind": 2048,
"kindString": "Method",
Expand All @@ -161,7 +161,7 @@
],
"signatures": [
{
"id": 11,
"id": 14,
"name": "__getBasePath",
"kind": 4096,
"kindString": "Call signature",
Expand All @@ -182,7 +182,7 @@
}
},
{
"id": 5,
"id": 8,
"name": "github",
"kind": 2048,
"kindString": "Method",
Expand All @@ -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",
Expand All @@ -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,
Expand Down Expand Up @@ -247,24 +300,25 @@
"title": "Properties",
"kind": 1024,
"children": [
8,
9
11,
12
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
12,
10,
15,
13,
8,
5
]
}
],
"sources": [
{
"fileName": "index.ts",
"line": 15,
"line": 16,
"character": 34
}
],
Expand Down
51 changes: 37 additions & 14 deletions doc/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,21 +61,44 @@ <h1>cicd</h1>
<a href="#组件说明" id="组件说明" style="color: inherit; text-decoration: none;">
<h2>组件说明</h2>
</a>
<a href="#使用场景" id="使用场景" style="color: inherit; text-decoration: none;">
<h2>使用场景</h2>
<p>通过该组件，可以快速帮助使用者创建CI/CD模板，或提供对应的CI/CD解决方案</p>
<a href="#所支持的平台" id="所支持的平台" style="color: inherit; text-decoration: none;">
<h2>所支持的平台</h2>
</a>
<a href="#具体用法" id="具体用法" style="color: inherit; text-decoration: none;">
<h2>具体用法</h2>
</a>
<a href="#s-cli-方式" id="s-cli-方式" style="color: inherit; text-decoration: none;">
<h3>s cli 方式</h3>
</a>
<pre><code><span style="color: #001080">s</span><span style="color: #000000"> </span><span style="color: #001080">cli</span><span style="color: #000000"> &lt;</span><span style="color: #001080">componentname</span><span style="color: #000000">&gt; -</span><span style="color: #001080">d</span>
</code></pre>
<a href="#应用编排使用方式" id="应用编排使用方式" style="color: inherit; text-decoration: none;">
<h3>应用编排使用方式</h3>
</a>
<p>查看 example下 s.yaml</p>
<ul>
<li><p>Github Action</p>
<ul>
<li>使用方法：<code>s cli cicd github</code></li>
<li>参考文档：<ul>
<li>如何通过Github Action使用Serverless Devs做CI/CD：<a href="http://short.devsapp.cn/cicd/github/action/usage">http://short.devsapp.cn/cicd/github/action/usage</a></li>
<li>Serverless Devs的官网是通过Serverless Devs部署的: <a href="http://short.devsapp.cn/cicd/github/action/practice">http://short.devsapp.cn/cicd/github/action/practice</a></li>
</ul>
</li>
</ul>
</li>
<li><p>[Future]:</p>
<ul>
<li>jenkins</li>
<li>云效</li>
<li>CircleCI</li>
<li>GitLab CI / CD</li>
<li>Travis CI</li>
<li>Azure Pipelines</li>
<li>CodeShip</li>
<li>......</li>
</ul>
</li>
</ul>
<hr>
<p>设计文档：<a href="./Design-Documentation.md">Design-Documentation.md</a></p>
<blockquote>
<p>目前CI/CD方案正在建设中，欢迎大家提供相对应的方案：</p>
<ul>
<li>模板内容，例如<a href="./src/template/github/action/serverless-devs.yml">serverless-devs.yml</a></li>
<li>相关文档，例如<a href="http://short.devsapp.cn/cicd/github/action/usage">如何通过Github Action使用Serverless Devs做CI/CD</a></li>
<li>最佳实践，例如<a href="http://short.devsapp.cn/cicd/github/action/practice">Serverless Devs的官网是通过Serverless Devs部署的</a></li>
</ul>
</blockquote>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
Expand Down
6 changes: 6 additions & 0 deletions lib/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@ import BaseComponent from './common/base';
import { InputProps } from './common/entity';
export default class ComponentDemo extends BaseComponent {
constructor(props: any);
/**
* 交互式获取CI/CD解决方案（默认方法）
* @param inputs
* @returns
*/
index(inputs: InputProps): Promise<void>;
/**
* 创建Github Action模板
* @param inputs
Expand Down
Loading

0 comments on commit 7357e55

Please sign in to comment.