Skip to content

Commit ec2d8d0

Browse files
arvinxxarvinxx
committed
📝 build: add document
try to build
1 parent 059c7c8 commit ec2d8d0

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

‎packages/release-config/README.md‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,16 +63,13 @@ module.exports = config;
6363

6464
# GithubPluginOpts
6565

66-
| name | type | optional | default | description |
67-
| ------------------- | ---------- | -------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------ |
68-
| githubUrl | `string` | `true` | `GH_URL` or `GITHUB_URL` environment variable. | The GitHub Enterprise endpoint. |
69-
| githubApiPathPrefix | `string` | `true` | `GH_PREFIX` or `GITHUB_PREFIX` environment variable. | The GitHub Enterprise API prefix. |
70-
| githubAssets | `string[]` | `true` | `-` | An array of files to upload to the release. See [assets](#assets). |
71-
| proxy | `string` | `true` | ``HTTP_PROXY` environment variable.` | The proxy to use to access the GitHub API. See [proxy](#proxy). |
72-
| successComment | `string` | `true` | ``:tada: This issue has been resolved in version ${nextRelease.version} :tada: | The release is available on [GitHub release](github_release_url)`` |
73-
74-
The [assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users) to add to the
75-
issue created when a release fails. |
66+
| name | type | optional | default | description |
67+
| ------------------- | ---------- | -------- | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
68+
| githubUrl | `string` | `true` | `GH_URL` or `GITHUB_URL` environment variable. | The GitHub Enterprise endpoint. |
69+
| githubApiPathPrefix | `string` | `true` | `GH_PREFIX` or `GITHUB_PREFIX` environment variable. | The GitHub Enterprise API prefix. |
70+
| githubAssets | `string[]` | `true` | `-` | An array of files to upload to the release. See [assets](#assets). |
71+
| proxy | `string` | `true` | ``HTTP_PROXY` environment variable.` | The proxy to use to access the GitHub API. See [proxy](#proxy). |
72+
| successComment | `string` | `true` | ``:tada: This issue has been resolved in version ${nextRelease.version} :tada: | The release is available on [GitHub release](github_release_url) The [assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users) to add to the issue created when a release fails. |
7673

7774
## License
7875

0 commit comments

Comments
 (0)