Skip to content

Feat: Ability to Grab Issues from Other GitHub Repos #4

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

Open
omgitsbillryan wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Feat: Ability to Grab Issues from Other GitHub Repos #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
feb97bb
Feat: Specify a Target GitHub Repository
Sep 23, 2021
64ceb24
update readme.md with optional repository param
Sep 23, 2021
a2aae2b
optionally include owner & repo
Sep 23, 2021
659eb2c
clean up param parsing for readability
Sep 23, 2021
6d2aab2
debug logging
Sep 24, 2021
260a6f5
2nd attempt at debug logging
Sep 24, 2021
1ebaad3
woops, deleted that PAT
Sep 24, 2021
27045fc
hmm, is this messing with my inputs
Sep 24, 2021
9d6b22b
going nuclear
Sep 24, 2021
fd94e8b
Merge pull request #1 from omgitsbillryan/feat/target-gh-repository
Sep 24, 2021
8843439
put code back in place
Sep 24, 2021
2a6e8c7
update action.yml
Sep 24, 2021
01bedb0
repository is required, no need to pretend it isnt
Sep 24, 2021
31eae32
build the dang thing
Sep 28, 2021
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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ octodemo/template-demo-github-user-search
| --------------------------| -------- | ------------------------------- |
| `github_token` | `true` | PAT(Personal Access Token) for accessing the issues on the repository, defaults to `${{ github.token }}`. |
| `issue_id` | `true` | The id of the issue to load the content from.|
| `repository` | `false` | The repository where the issue lives. Defaults to the current repository.|
| `separator` | `false` | The separator between the fields defaults to `###` which is markdown h3 which GitHub is currently defaulting to |
| `label_marker_start` | `true` | The characters to match for the beginning of a label |
| `label_marker_end` | `true` | The characters to match for the ending of a label |
Expand All @@ -48,6 +49,7 @@ steps:
uses: peter-murray/issue-forms-body-parser@v1.1.0
with:
issue_id: ${{ github.event.issue.number }}
repository: octokit/rest.js
separator: '###'
label_marker_start: '>>'
label_marker_end: '<<'
Expand Down
5 changes: 5 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ inputs:
default: ${{ github.token }}
required: true

repository:
description: The GitHub repository where the issue lives
default: ${{ github.repository }}
required: true

issue_id:
description: The id of the issue to use to extract a payload from the body
required: true
Expand Down
10 changes: 7 additions & 3 deletions dist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,14 @@ async function run() {
, parserSeparator = getRequiredInputValue('separator')
, parserMarkerStart = getRequiredInputValue('label_marker_start')
, parserMarkerEnd = getRequiredInputValue('label_marker_end')
, repository = getRequiredInputValue('repository')
;

const issueUtil = new IssueUtil(githubToken)
, parser = new Parser(parserSeparator, parserMarkerStart, parserMarkerEnd)
;

const issueBody = await issueUtil.getIssueBody(issueId);
const issueBody = await issueUtil.getIssueBody(issueId, repository);

const parsed = parser.parse(issueBody);
if (parsed !== undefined) {
Expand Down Expand Up @@ -5885,9 +5886,11 @@ module.exports = class IssueUtil {
this.octokit = github.getOctokit(token);
}

getIssueBody(id) {
getIssueBody(id, repository) {
const [owner, repo] = repository.split('/');

return this.octokit.issues.get({
...github.context.repo,
...{owner, repo},
issue_number: id
}).then(result => {
if (result.status !== 200) {
Expand All @@ -5900,6 +5903,7 @@ module.exports = class IssueUtil {
}
}


/***/ }),

/***/ 657:
Expand Down
3 changes: 2 additions & 1 deletion index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@ async function run() {
, parserSeparator = getRequiredInputValue('separator')
, parserMarkerStart = getRequiredInputValue('label_marker_start')
, parserMarkerEnd = getRequiredInputValue('label_marker_end')
, repository = getRequiredInputValue('repository')
;

const issueUtil = new IssueUtil(githubToken)
, parser = new Parser(parserSeparator, parserMarkerStart, parserMarkerEnd)
;

const issueBody = await issueUtil.getIssueBody(issueId);
const issueBody = await issueUtil.getIssueBody(issueId, repository);

const parsed = parser.parse(issueBody);
if (parsed !== undefined) {
Expand Down
8 changes: 5 additions & 3 deletions src/IssueUtil.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ module.exports = class IssueUtil {
this.octokit = github.getOctokit(token);
}

getIssueBody(id) {
getIssueBody(id, repository) {
const [owner, repo] = repository.split('/');
Copy link
Copy Markdown
Owner

@peter-murray peter-murray Jan 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My only issue here is that it is possible for a user to provide an input that is not in this form and we would not detect this of fail nicely with the following call.

I would suggest that we validate the repository input early in the execution when we obtain that value from the user inputs and pass a consistent {owner: '', repo: ''} object to this function.


return this.octokit.issues.get({
...github.context.repo,
...{owner, repo},
issue_number: id
}).then(result => {
if (result.status !== 200) {
Expand All @@ -22,4 +24,4 @@ module.exports = class IssueUtil {
throw err;
});
}
}
}