-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
74 additions
and
142 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,8 @@ on: | |
- develop | ||
paths: | ||
- 'docs/docs/**' | ||
pull_request: | ||
types: [closed] | ||
workflow_dispatch: | ||
|
||
jobs: | ||
|
@@ -16,19 +18,17 @@ jobs: | |
- name: Setup Node.js | ||
uses: actions/setup-node@v2 | ||
with: | ||
ref: 'develop' | ||
node-version: '16' | ||
node-version: '18' | ||
registry-url: 'https://registry.npmjs.org' | ||
- run: cd docs && npm install | ||
- run: pnpm install | ||
- run: | | ||
cd docs | ||
npm version patch | ||
git config --local user.email "[email protected]" | ||
git config --local user.name "GitHub Action" | ||
git add package.json | ||
git commit -m "chore(docs): publish documentation" | ||
git push | ||
- run: cd docs && npm run build && npm publish | ||
- run: pnpm build | ||
env: | ||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} | ||
- name: Get version | ||
|
@@ -40,14 +40,14 @@ jobs: | |
runs-on: ubuntu-latest | ||
steps: | ||
- name: Comment on PR | ||
if: github.event_name == 'pull_request' && github.event.action == 'closed' && github.event.pull_request.merged == true | ||
uses: actions/github-script@v4 | ||
if: github.event_name == 'pull_request' && github.action == 'closed' && github.event.pull_request.merged == true | ||
uses: actions/github-script@v6 | ||
with: | ||
github-token: ${{ secrets.GITHUB_TOKEN }} | ||
script: | | ||
github.issues.createComment({ | ||
issue_number: context.issue.number, | ||
owner: context.repo.owner, | ||
repo: context.repo.repo, | ||
body: '🚀 New version has been released: ' + '${{ needs.publish-docs.outputs.version }}' | ||
body: '🚀 New version has been released: ' + '${{ needs.publish-docs.outputs }}' | ||
}) |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,15 +20,12 @@ | |
|
||
[npm-image]: https://img.shields.io/npm/v/@alilc/lowcode-engine.svg?style=flat-square | ||
[npm-url]: http://npmjs.org/package/@alilc/lowcode-engine | ||
|
||
[download-image]: https://img.shields.io/npm/dm/@alilc/lowcode-engine.svg?style=flat-square | ||
[download-url]: https://npmjs.org/package/@alilc/lowcode-engine | ||
[help-wanted-image]: https://flat.badgen.net/github/label-issues/alibaba/lowcode-engine/help%20wanted/open | ||
[help-wanted-url]: https://github.com/alibaba/lowcode-engine/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22 | ||
|
||
[issues-helper-image]: https://img.shields.io/badge/using-issues--helper-orange?style=flat-square | ||
[issues-helper-url]: https://github.com/actions-cool/issues-helper | ||
|
||
[codecov-image-url]: https://codecov.io/gh/alibaba/lowcode-engine/branch/main/graph/badge.svg | ||
[codecov-url]: https://codecov.io/gh/alibaba/lowcode-engine | ||
|
||
|
@@ -73,8 +70,7 @@ skeleton.add({ | |
name: 'logo', | ||
content: YourFantasticLogo, | ||
contentProps: { | ||
logo: | ||
'https://img.alicdn.com/tfs/TB1_SocGkT2gK0jSZFkXXcIQFXa-66-66.png', | ||
logo: 'https://img.alicdn.com/tfs/TB1_SocGkT2gK0jSZFkXXcIQFXa-66-66.png', | ||
href: '/', | ||
}, | ||
props: { | ||
|
@@ -87,6 +83,7 @@ init(document.getElementById('lce')); | |
``` | ||
|
||
### 工程化配置: | ||
|
||
```json | ||
{ | ||
"externals": { | ||
|
@@ -97,35 +94,37 @@ init(document.getElementById('lce')); | |
``` | ||
|
||
### cdn 可选方式: | ||
|
||
#### 方式 1(推荐):alifd cdn | ||
|
||
```html | ||
https://alifd.alicdn.com/npm/@alilc/[email protected]/dist/js/engine-core.js | ||
|
||
https://alifd.alicdn.com/npm/@alilc/[email protected]/dist/js/react-simulator-renderer.js | ||
``` | ||
|
||
#### 方式 2(推荐):uipaas cdn | ||
|
||
```html | ||
https://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/1.0.18/dist/js/engine-core.js | ||
|
||
https://uipaas-assets.com/prod/npm/@alilc/lowcode-react-simulator-renderer/1.0.18/dist/js/react-simulator-renderer.js | ||
``` | ||
|
||
#### 方式 3:unpkg | ||
|
||
```html | ||
https://unpkg.com/@alilc/[email protected]/dist/js/engine-core.js | ||
|
||
https://unpkg.com/@alilc/[email protected]/dist/js/react-simulator-renderer.js | ||
``` | ||
|
||
#### 方式 4:jsdelivr | ||
|
||
```html | ||
https://cdn.jsdelivr.net/npm/@alilc/[email protected]/dist/js/engine-core.js | ||
|
||
https://cdn.jsdelivr.net/npm/@alilc/[email protected]/dist/js/react-simulator-renderer.js | ||
``` | ||
|
||
#### 方式 5:使用自有 cdn | ||
|
||
将源码中 packages/engine/dist 和 packages/react-simulator-renderer/dist 下的文件传至你的 cdn 提供商 | ||
|
||
## 🔗 相关链接 | ||
|
@@ -146,9 +145,8 @@ https://cdn.jsdelivr.net/npm/@alilc/[email protected]/dist | |
```bash | ||
$ git clone [email protected]:alibaba/lowcode-engine.git | ||
$ cd lowcode-engine | ||
$ npm install | ||
$ npm run setup | ||
$ npm start | ||
$ pnpm install | ||
$ pnpm playground | ||
``` | ||
|
||
> 📢 npm 访问速度较慢,阿里员工可以使用 tnpm,其他同学建议使用 cnpm 或者指定镜像 registry。 | ||
|
@@ -160,6 +158,7 @@ lowcode-engine 启动后,提供了几个 umd 文件,可以结合 [lowcode-de | |
## 🤝 参与共建 | ||
|
||
请先阅读: | ||
|
||
1. [如何配置引擎调试环境?](https://lowcode-engine.cn/site/docs/participate/prepare) | ||
2. [关于引擎的研发协作流程](https://lowcode-engine.cn/site/docs/participate/flow) | ||
3. [引擎的工程化配置](https://lowcode-engine.cn/site/docs/participate/config) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,15 +20,12 @@ An enterprise-class low-code technology stack with scale-out design | |
|
||
[npm-image]: https://img.shields.io/npm/v/@alilc/lowcode-engine.svg?style=flat-square | ||
[npm-url]: http://npmjs.org/package/@alilc/lowcode-engine | ||
|
||
[download-image]: https://img.shields.io/npm/dm/@alilc/lowcode-engine.svg?style=flat-square | ||
[download-url]: https://npmjs.org/package/@alilc/lowcode-engine | ||
[help-wanted-image]: https://flat.badgen.net/github/label-issues/alibaba/lowcode-engine/help%20wanted/open | ||
[help-wanted-url]: https://github.com/alibaba/lowcode-engine/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22 | ||
|
||
[issues-helper-image]: https://img.shields.io/badge/using-issues--helper-orange?style=flat-square | ||
[issues-helper-url]: https://github.com/actions-cool/issues-helper | ||
|
||
[codecov-image-url]: https://codecov.io/gh/alibaba/lowcode-engine/branch/main/graph/badge.svg | ||
[codecov-url]: https://codecov.io/gh/alibaba/lowcode-engine | ||
|
||
|
@@ -73,8 +70,7 @@ skeleton.add({ | |
name: 'logo', | ||
content: YourFantasticLogo, | ||
contentProps: { | ||
logo: | ||
'https://img.alicdn.com/tfs/TB1_SocGkT2gK0jSZFkXXcIQFXa-66-66.png', | ||
logo: 'https://img.alicdn.com/tfs/TB1_SocGkT2gK0jSZFkXXcIQFXa-66-66.png', | ||
href: '/', | ||
}, | ||
props: { | ||
|
@@ -87,6 +83,7 @@ init(document.getElementById('lce')); | |
``` | ||
|
||
### Engineering configuration: | ||
|
||
```json | ||
{ | ||
"externals": { | ||
|
@@ -97,35 +94,37 @@ init(document.getElementById('lce')); | |
``` | ||
|
||
### cdn optional method: | ||
|
||
#### Method 1: alifd cdn | ||
|
||
```html | ||
https://alifd.alicdn.com/npm/@alilc/[email protected]/dist/js/engine-core.js | ||
|
||
https://alifd.alicdn.com/npm/@alilc/[email protected]/dist/js/react-simulator-renderer.js | ||
``` | ||
|
||
#### Method 2: uipaas cdn | ||
|
||
```html | ||
https://uipaas-assets.com/prod/npm/@alilc/lowcode-engine/1.0.18/dist/js/engine-core.js | ||
|
||
https://uipaas-assets.com/prod/npm/@alilc/lowcode-react-simulator-renderer/1.0.18/dist/js/react-simulator-renderer.js | ||
``` | ||
|
||
#### Method 3: unpkg | ||
|
||
```html | ||
https://unpkg.com/@alilc/[email protected]/dist/js/engine-core.js | ||
|
||
https://unpkg.com/@alilc/[email protected]/dist/js/react-simulator-renderer.js | ||
``` | ||
|
||
#### Method 4: jsdelivr | ||
|
||
```html | ||
https://cdn.jsdelivr.net/npm/@alilc/[email protected]/dist/js/engine-core.js | ||
|
||
https://cdn.jsdelivr.net/npm/@alilc/[email protected]/dist/js/react-simulator-renderer.js | ||
``` | ||
|
||
#### Method 5: Use your own cdn | ||
|
||
Pass the files under packages/engine/dist and packages/react-simulator-renderer/dist in the source code to your cdn provider | ||
|
||
## 🔗 Related Links | ||
|
@@ -146,9 +145,8 @@ This [awesome-lowcode-engine](https://github.com/lowcode-workspace/awesome-lowco | |
```bash | ||
$ git clone [email protected]:alibaba/lowcode-engine.git | ||
$ cd lowcode-engine | ||
$ npm install | ||
$ npm run setup | ||
$ npm start | ||
$ pnpm install | ||
$ pnpm playground | ||
``` | ||
|
||
> 📢 npm access speed is slow, Alibaba employees can use tnpm, other students recommend using cnpm or specifying a mirror registry. | ||
|
@@ -160,13 +158,15 @@ After lowcode-engine is started, several umd files are provided, which can be de | |
## 🤝 Participation | ||
|
||
Please read first: | ||
|
||
1. [How to configure the engine debugging environment? ](https://lowcode-engine.cn/site/docs/participate/prepare) | ||
2. [About the R&D collaboration process of the engine](https://lowcode-engine.cn/site/docs/participate/flow) | ||
3. [Engineering Configuration of Engine](https://lowcode-engine.cn/site/docs/participate/config) | ||
|
||
> Strongly recommend reading ["The Wisdom of Asking Questions"](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way), ["How to Ask Questions to the Open Source Community"](https: //github.com/seajs/seajs/issues/545) and [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html), [ "How to Submit Unanswerable Questions to Open Source Projects"](https://zhuanlan.zhihu.com/p/25795393), better questions are easier to get help. (This paragraph refers to [antd](https://github.com/ant-design/ant-design)) | ||
About Pull Request: | ||
|
||
- set the target branch to **develop** other than **main** | ||
|
||
## ❤️ Contributors | ||
|
Oops, something went wrong.