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.

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

Simplification and modification of features #8

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
42 changes: 23 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,37 @@
Unlock an issue. By default, it uses the context's but can be targetted.

### Targetting context's issue:

- uses: OSDKDev/unlock-issues@v1.1
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"

```yml
- name: Unlock issue
uses: OSDKDev/unlock-issues@v1.2
```
#### Sample file: `.github/workflows/unlock-reopened-issues.yml`
name: Unlock reopened issue
```yml
name: Unlock reopened issue

on:
issues:
types: [reopened]
on:
issues:
types: [reopened]

jobs:
lock:
runs-on: ubuntu-latest
steps:
- uses: OSDKDev/unlock-issues@v1.1
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"

jobs:
unlock:
name: Unlock
runs-on: ubuntu-latest
permissions:
issues: write
steps:
- name: Unlock issue
uses: OSDKDev/unlock-issues@v1.2
```
As simple as that!

### Targetting a specific issue / repo:

- uses: OSDKDev/unlock-issues@v1.1
```yml
- name: Unlock issue
uses: OSDKDev/unlock-issues@v1.2
with:
repo-token: {Token with permissions over the target repository / issue}
owner-name: {Owner Name - Optional - Default: Context's Repository Owner}
repo-name: {Repository Name - Optional - Default: Context's Repository}
issue-number: {Issue Number - Optional - Default: Context's Issue}
```
3 changes: 2 additions & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ inputs:
repo-token:
description: 'Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }}'
required: true
default: '${{ github.token }}'
issue-number:
description: "Issue number. Defaults to context's issue"
required: false
Expand All @@ -17,5 +18,5 @@ branding:
icon: unlock
color: black
runs:
using: 'node12'
using: 'node20'
main: 'src/unlock.js'