wbrawner/action-gh-release
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge remote-tracking branch 'upstream/master' into default-token

Browse source
This commit is contained in:
Caleb Maclennan 2021-03-21 10:12:40 +03:00
commit 05d11c9fe8
No known key found for this signature in database
GPG key ID: 63CC496475267693
5 changed files with 28 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -154,6 +154,8 @@ jobs:
if: startsWith(github.ref, 'refs/tags/')
with:
body_path: ${{ github.workflow }}-CHANGELOG.txt
env:
GITHUB_REPOSITORY: my_gh_org/my_gh_repo
```
### 💅 Customizing
@ -162,18 +164,17 @@ jobs:
The following are optional as `step.with` keys
| Name | Type | Description |
|---------------------------|---------|---------------------------------------------------------------------------------------------|
| `body` | String | Text communicating notable changes in this release |
| `body_path` | String | Path to load text communicating notable changes in this release |
| `draft` | Boolean | Indicator of whether or not this release is a draft |
| `prerelease` | Boolean | Indicator of whether or not is a prerelease |
| `files` | String | Newline-delimited globs of paths to assets to upload for release |
| `name` | String | Name of the release. defaults to tag name |
| `tag_name` | String | Name of a tag. defaults to `github.ref` |
| `repository` | String | Name of a target repository in `<owner>/<repo>` format. Defaults to the current repository. |
| `fail_on_unmatched_files` | Boolean | Indicator of whether to fail if any of the `files` globs match nothing |
| `token` | String | Secret GitHub Personal Access Token. Defaults to `${{ github.token }}` |
| Name | Type | Description |
|---------------------------|---------|-----------------------------------------------------------------------|
| `body` | String | Text communicating notable changes in this release |
| `body_path` | String | Path to load text communicating notable changes in this release |
| `draft` | Boolean | Indicator of whether or not this release is a draft |
| `prerelease` | Boolean | Indicator of whether or not is a prerelease |
| `files` | String | Newline-delimited globs of paths to assets to upload for release |
| `name` | String | Name of the release. defaults to tag name |
| `tag_name` | String | Name of a tag. defaults to `github.ref` |
| `fail_on_unmatched_files` | Boolean | Indicator of whether to fail if any of the `files` globs match nothing|
| `token` | String | Secret GitHub Personal Access Token. Defaults to `${{ github.token }}`|
💡When providing a `body` and `body_path` at the same time, `body_path` will be attempted first, then falling back on `body` if the path can not be read from.
@ -181,18 +182,20 @@ The following are optional as `step.with` keys
The following outputs can be accessed via `${{ steps.<step-id>.outputs }}` from this action
| Name | Type | Description |
|-------------|---------|--------------------------------|
| `url` | String | Github.com URL for the release |
| Name | Type | Description |
|-------------|---------|-----------------------------------------------------------------|
| `url` | String | Github.com URL for the release |
| `upload_url`| String | URL for uploading assets to the release |
#### environment variables
The following `step.env` keys are allowed as a fallback but deprecated in favor of using inputs.
| Name | Description |
|----------------|---------------------------------------|
| `GITHUB_TOKEN` | GITHUB_TOKEN as provided by `secrets` |
| Name | Description |
|----------------|------------------------------------------------------------------------------------------------|
| `GITHUB_TOKEN` | GITHUB_TOKEN as provided by `secrets` |
| `GITHUB_REPOSITORY` | Name of a target repository in `<owner>/<repo>` format. defaults to the current repository|
> **⚠️ Note:** This action was previously implemented as a Docker container, limiting its use to GitHub Actions Linux virtual environments only. With recent releases, we now support cross platform usage. You'll need to remove the `docker://` prefix in these versions

4
__tests__/util.test.ts
View file

@ -58,9 +58,9 @@ describe("util", () => {
})
);
});
it("defaults to body when both body and body path are provided", () => {
it("defaults to body path when both body and body path are provided", () => {
assert.equal(
"foo",
"bar",
releaseBody({
github_ref: "",
github_repository: "",

2
action.yml
View file

@ -39,6 +39,8 @@ env:
outputs:
url:
description: 'URL to the Release HTML Page'
upload_url:
description: 'URL for uploading assets to the release'
runs:
using: 'node12'
main: 'dist/index.js'

1
src/main.ts
View file

@ -55,6 +55,7 @@ async function run() {
}
console.log(`🎉 Release ready at ${rel.html_url}`);
setOutput("url", rel.html_url);
setOutput("upload_url", rel.upload_url);
} catch (error) {
setFailed(error.message);
}

4
src/util.ts
View file

@ -20,9 +20,9 @@ export interface Config {
export const releaseBody = (config: Config): string | undefined => {
return (
config.input_body ||
(config.input_body_path &&
readFileSync(config.input_body_path).toString("utf8"))
readFileSync(config.input_body_path).toString("utf8")) ||
config.input_body
);
};