Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Patch 1 #2

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Patch 1 #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
964a72b
Support searching draft releases by target tag
eritbh Jul 3, 2023
17ca56b
bump lockfile version
eritbh Jul 3, 2023
e16a6aa
npm audit fix
eritbh Jul 3, 2023
b30c6d4
update README contents to reflect fork location
eritbh Jul 3, 2023
e45c7bb
Update action.yml
JeelsBoobz Jul 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@

A GitHub action to publish release drafts on GitHub.

This task searches for a release draft with a given tag name. If the draft is found, the task attaches the tag (if it exists) to this release, then publishes the release.
This task searches for a release draft with a given target tag. If the draft is found, the task publishes the release.

> **Note**
> This is a fork of [test-room-7/action-publish-release-drafts](https://github.com/test-room-7/action-publish-release-drafts), modified to match draft releases by tag name rather than by release title.

## Usage

Expand All @@ -26,18 +29,18 @@ jobs:
id: get-version
run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
- name: Publish release on GitHub
uses: test-room-7/action-publish-release-drafts@v0
uses: eritbh/action-publish-release-drafts@v0
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
tag-name: ${{ steps.get-version.outputs.VERSION }}
```

### Example of basic usage

1. Create a new draft reserved for a new version, and name it in a semver format, e.g. `v0.1.0`.
1. Create a new draft reserved for a new version, and give it the appropriate tag target (e.g. `v0.1.0`).
2. Update a description of the draft during development, if neccessary.
3. When a new version is ready, push the tag to repository (`v0.1.0` in this case).
4. The action will be executed, and it will apply the `v0.1.0` tag to the draft, and will publish it.
3. When a new version is ready, push the matching tag to repository (`v0.1.0` in this case).
4. The action will be executed, and the draft will be published.

### Inputs

Expand Down Expand Up @@ -65,7 +68,7 @@ Don't push dist files; they're updated automatically.

Licensed under the [MIT License](./LICENSE.md).

[version-badge]: https://img.shields.io/github/v/release/test-room-7/action-publish-release-drafts
[version-badge]: https://img.shields.io/github/v/release/eritbh/action-publish-release-drafts
[version-url]: https://github.com/marketplace/actions/publish-release-drafts
[workflow-badge]: https://img.shields.io/github/workflow/status/test-room-7/action-publish-release-drafts/Lint?label=lint
[workflow-url]: https://github.com/test-room-7/action-publish-release-drafts/actions
[workflow-badge]: https://img.shields.io/github/workflow/status/eritbh/action-publish-release-drafts/Lint?label=lint
[workflow-url]: https://github.com/eritbh/action-publish-release-drafts/actions
2 changes: 1 addition & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ inputs:
description: GitHub token
requried: true
runs:
using: node12
using: node16
main: dist/index.js
branding:
icon: tag
Expand Down
Loading