Skip to content

Commit

Permalink
Optional targeting (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
IOrlandoni committed Nov 18, 2019
1 parent 5f2c2c3 commit 2838201
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 11 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,33 @@
Automatically unlock context issue, most commonly used on "reopened" event.
Unlock an issue. By default, it uses the context's but can be targetted.

To add it to your workflow:
### Targetting context's issue:

- uses: OSDKDev/unlock-issues@v1
- uses: OSDKDev/unlock-issues@v1.1
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
Sample file: `.github/workflows/unlock-reopened-issues.yml`

#### Sample file: `.github/workflows/unlock-reopened-issues.yml`
name: Unlock reopened issue

on:
issues:
types: [reopened]

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

### Targetting a specific issue / repo:

- uses: OSDKDev/unlock-issues@v1.1
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}
9 changes: 9 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ inputs:
repo-token:
description: 'Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }}'
required: true
issue-number:
description: "Issue number. Defaults to context's issue"
required: false
owner-name:
description: "Repository owner's username. Defaults to context's repository owner"
required: false
repo-name:
description: "Repository name. Defaults to context's repository"
required: false
branding:
icon: unlock
color: black
Expand Down
14 changes: 10 additions & 4 deletions src/unlock.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,20 @@ async function unlock() {
const myToken = core.getInput("repo-token");
const octokit = new github.GitHub(myToken);
const context = github.context;

const issue = core.getInput("issue-number") || context.payload.issue.number;
const repo = core.getInput("repo-name") || context.payload.repository.name;
const owner = core.getInput("owner-name") || context.payload.repository.owner.login;

console.log("Attempting to unlock " + owner + "/" + repo + "/issues/" + issue);

await octokit.issues.unlock({
owner: context.payload.repository.owner.login,
repo: context.payload.repository.name,
issue_number: context.payload.issue.number
owner: owner,
repo: repo,
issue_number: parseInt(issue)
});

return context.payload.issue.number;
return issue;
}

unlock()
Expand Down

0 comments on commit 2838201

Please sign in to comment.