Added optional comment to payload

This commit is contained in:
Martyn Janes
2019-12-20 08:44:21 +01:00
parent fdff4a62df
commit 127cd44cb4
5 changed files with 10 additions and 4 deletions

View File

@@ -13,6 +13,7 @@ The action will perform the following steps:
### Inputs
- `tag_name`: The name of the tag for this release
- `comment`: An optional comment to include in the Tangle payload
### Outputs
@@ -28,6 +29,7 @@ The action will perform the following steps:
"repo": "test-repo",
"tag_name": "v0.1.0",
"name": "First full release",
"comment": "My Awesome Release",
"body": "This is the body of the description.",
"tarball_url": "https://api.github.com/repos/an-owner/test-repo/tarball/v0.1.0",
"tarball_sig": "Me3ouGni0h50TOHQklopu3sJdLFh/ZVlPJom3aDRFVQ=",
@@ -53,7 +55,7 @@ The action will perform the following steps:
## Usage
Create a GitHub workflow in you repo e.g. `/.github/workflows/tangle-release.yml`.
Most of the environment variables are optional, except for the `IOTA_SEED` which must be 81 trytes in length.
Most of the environment variables are optional, except for the `IOTA_SEED` which must be 81 trytes in length. For more details on creating a seed see [IOTA Docs - Getting Started - Creating A Seed](https://docs.iota.org/docs/getting-started/0.1/tutorials/create-a-seed)
```yaml
on:
@@ -82,7 +84,7 @@ jobs:
IOTA_EXPLORE_URL: ${{ secrets.IOTA_EXPLORE_URL }} # Optional, defaults to https://utils.iota.org/transaction/:hash
with:
tag_name: ${{ github.ref }}
comment: My Awesome Release
```
## Returns

2
dist/index.js vendored
View File

@@ -32051,6 +32051,7 @@ async function run() {
const { owner, repo } = context.repo;
const tagName = core.getInput('tag_name', { required: true });
const comment = core.getInput('comment', { required: false });
const release = await github.repos.getReleaseByTag({
owner,
@@ -32066,6 +32067,7 @@ async function run() {
repo,
tag_name: release.data.tag_name,
name: release.data.name,
comment,
body: release.data.body,
tarball_url: release.data.tarball_url,
tarball_sig: tarBallHash,

2
package-lock.json generated
View File

@@ -1,6 +1,6 @@
{
"name": "gh-tangle-release",
"version": "1.0.0",
"version": "0.5.1",
"lockfileVersion": 1,
"requires": true,
"dependencies": {

View File

@@ -1,6 +1,6 @@
{
"name": "gh-tangle-release",
"version": "0.5.0",
"version": "0.5.1",
"description": "Create a release and adds metadata to the tangle",
"main": "dist/index.js",
"scripts": {

View File

@@ -35,6 +35,7 @@ async function run() {
const { owner, repo } = context.repo;
const tagName = core.getInput('tag_name', { required: true });
const comment = core.getInput('comment', { required: false });
const release = await github.repos.getReleaseByTag({
owner,
@@ -50,6 +51,7 @@ async function run() {
repo,
tag_name: release.data.tag_name,
name: release.data.name,
comment,
body: release.data.body,
tarball_url: release.data.tarball_url,
tarball_sig: tarBallHash,