20 Commits

Author SHA1 Message Date
Andy McKay
fb0ec4641e
Update README.md 2021-03-03 11:00:51 -08:00
Andy McKay
48563c39a1
Update README.md 2021-01-29 13:58:46 -08:00
Andy McKay
9c7d5cff21
Mark as unmaintained
Add in a notice about the upcoming lack of intended maintenance on this repository. We'd like to make it clear to visitors to this repository about it's state. This process of marking it unmaintained only affects future updates. The Action will still continue work as it is in old workflows.

Closes #119

Once this lands, we'll also Archive this repository.

If you've got good recommendations for replacements, please let me know, we'll add them into the README.
2021-01-29 13:52:28 -08:00
Thomas Hughes
8868c043d3
Add commitish to inputs in README 2020-09-14 08:49:18 -05:00
Chris McIntosh
7c69cb4ced
Updating readme with new inputs 2020-09-14 08:24:33 -05:00
Mike Coutermarsh
8210505c40
Merge branch 'master' into master 2020-07-01 07:26:37 -07:00
eric sciple
6addae869b
Update readme example to pin to major version 2020-04-23 20:45:39 -04:00
Jacob Bolda
9d21c8a3f2
update readme with body_path 2020-04-11 23:19:42 -05:00
Jacob Bolda
3cd5bbb314
Update README.md 2020-03-07 22:20:23 -06:00
Anton Khitrenovich
0e420272a0
Update README to show usage of "latest" version
...otherwise `body` usage sample doesn't work, which results in a bunch of open issues on the topic.
2020-02-27 13:06:08 -05:00
sclaire-1
69b747352a
Edit README.md
Removed a word in the "Prerequisites" section to improve flow.
2019-11-18 12:31:28 -08:00
Steve Winton
d9c9ca3972
Merge pull request #11 from csexton/add-body
Include body parameter for release
2019-11-15 14:57:28 -08:00
Edward Thomson
2329f0d753 README: use v1 for semantic version goodness 2019-11-08 16:00:49 +00:00
Thomas Hughes
216650af00
Update README.md 2019-11-05 07:10:17 -06:00
Thomas Hughes
35e5c6da76
Add comment about GITHUB_TOKEN being provided by env 2019-11-04 16:17:19 -06:00
Christopher Sexton
becafb2f61 Include body parameter for release
Fixes #4

This adds the ability to include the body parameter when creating the
release.

    - name: Checkout code
      uses: actions/checkout@master
    - name: Create Release
      id: create_release
      uses: actions/create-release@master
      with:
        tag_name: ${{ github.ref }}
        release_name: Release ${{ github.ref }}
        body: Release body

This also supports a multiline body:

    - name: Create Release
      id: create_release
      uses: actions/create-release@master
      with:
        tag_name: ${{ github.ref }}
        release_name: Release ${{ github.ref }}
        body: |
          This is a multiline body
          with more than one
          line

Or if you want the contents of a file:

    - name: Read CHANGELOG
      id: changelog
      run: |
        echo "::set-output name=body::$(cat CHANGELOG.md)"
    - name: Create Release
      id: create_release
      uses: actions/create-release@master
      with:
        release_name: Release ${{ github.ref }}
        body: ${{ steps.changelog.outputs.body }}

One decision I made in favor of less code was to send an empty body when
there was non present. If it would be preferred to send nothing in the
request for the `body` attribute I could instead compose the parameters
with an optional body attribute:

    releaseParams = {
      owner,
      repo,
      tag_name: tag,
      name: releaseName,
      draft,
      prerelease
    };

    if (body) releaseParams.body = body;

    const createReleaseResponse = await github.repos.createRelease( releaseParams );
2019-10-22 12:24:23 -04:00
francisfuzz
05bdca6c98
docs: update README to include a closing backtick 2019-10-11 16:10:37 +02:00
Thomas Hughes
3d8e310430
Setup CI 2019-09-20 15:16:57 -05:00
Thomas Hughes
af260870f7
Update dev dependencies, add ESLint 2019-09-20 15:07:18 -05:00
Thomas Hughes
d0222fc862
Initial commit 2019-09-20 14:55:33 -05:00