Skip to content

Commit edeb1ae

Browse files
committed
feat: update release readme
1 parent 0bacb22 commit edeb1ae

File tree

2 files changed

+14
-18
lines changed

2 files changed

+14
-18
lines changed

release/README_cn-zh.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
> 例如 vendor, node_modules, eslint, config 都不會進去
1414
> 6. 排除 composer 開發依賴 composer install --no-dev
1515
> 7. 整個 release外掛檔案打包成 zip,上傳 github release
16-
>
16+
>
1717
> 然後用戶就會在 WordPress 後台收到外掛更新通知了
18-
>
18+
>
1919
> 以上動作就濃縮成一個指令 yarn release
2020
2121

@@ -77,16 +77,16 @@ composer install
7777

7878
然後修改內容
7979

80-
`GITHUB_TOKEN` 填入您的 [`github personal token`](github personal token)
80+
`GITHUB_TOKEN` 填入您的 [`github personal token`](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic)
8181

8282
`PLUGIN_NAME` 填入您的套件目錄名稱,如果填寫錯誤,將無法正確完成打包,🚩寫名稱就好,不需要寫路徑
8383

8484
```bash
85-
GITHUB_TOKEN="ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
85+
GITHUB_TOKEN="ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
8686
PLUGIN_NAME="wp-react-plugin"
8787
```
8888

89-
🚩🚩🚩 因為安全因素,請勿將 GITHUB_TOKEN, 即此 `.env` 納入 github 版本控制中 (預設已在 .gitignore 排除),否則 github 將會 Block 你的 push
89+
🚩🚩🚩 因為安全因素,請勿將 GITHUB_TOKEN, 即此 `.env` 納入 github 版本控制中 (預設已在 `.gitignore` 排除),否則 github 將會 Block 你的 push
9090

9191
---
9292

@@ -96,22 +96,20 @@ PLUGIN_NAME="wp-react-plugin"
9696

9797
所有預設 config 可以參考這 [default config](https://github.com/release-it/release-it/blob/main/config/release-it.json)
9898

99-
---
100-
101-
接著到 [`create-release.cjs`](https://github.com/j7-dev/wp-react-plugin/blob/master/release/create-release.cjs)
99+
接著到設定您要打包的目錄,只有被寫入在 `includes` array 內的檔案會被複製 (會遞規複製裡面的檔案&目錄),例如
102100

103-
設定您要打包的目錄,只有被寫入在 `includes` array 內的檔案會被複製 (會遞規複製裡面的檔案&目錄),例如
101+
```json
102+
// .release-it.cjs
104103

105-
```javascript
106-
const includes = [
104+
includes: [
107105
'inc',
108-
'js/dist', // 只複製 js/dist,而不會複製 js/src
106+
'js/dist', // 只複製 js/dist,而不會複製 js/src
109107
'required_plugins',
110108
'composer.json', // 需要這個是因為,打包過程中會執行 composer install --no-dev
111109
'composer.lock', // 需要這個是因為,打包過程中會執行 composer install --no-dev
112110
'index.php',
113111
'plugin.php',
114-
'README.md',
112+
'README.md'
115113
]
116114
```
117115

release/create-release.cjs

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,8 @@ const path = require('path')
1414
const { deleteRelease } = require('./delete-release.cjs')
1515
const { includes } = require('./.release-it.cjs')
1616
const pluginName = process?.env?.PLUGIN_NAME || 'wp-react-plugin'
17-
const srcDir = path.resolve(__dirname, '../')
18-
const destDir = path.resolve(__dirname, `./${pluginName}`)
19-
20-
console.log('⭐ includes:', includes)
17+
const sourceDir = path.resolve(__dirname, '../')
18+
const destinationDir = path.resolve(__dirname, `./${pluginName}`)
2119

2220
/**
2321
* Recursively copy directories and files
@@ -90,4 +88,4 @@ deleteRelease()
9088

9189
// then create release directory
9290

93-
recursiveCopy(srcDir, destDir, includes)
91+
recursiveCopy(sourceDir, destinationDir, includes)

0 commit comments

Comments
 (0)