feat(onlychanged): allow to lint only changed files in the pull request #4
Conversation
| @@ -0,0 +1 @@ | |||
| node_modules | |||
| @@ -12,6 +12,8 @@ inputs: | |||
| default: 'tslint.json' | |||
| pattern: | |||
| description: 'Glob pattern to match' | |||
| only-changed: | |||
| description: 'Apply glob patter only to changed files' | |||
There was a problem hiding this comment.
It would be nice if we add restriction about this option - it only works with pull_event trigger
| @@ -41,7 +42,7 @@ const SeverityAnnotationLevelMap = new Map<RuleSeverity, "warning" | "failure">( | |||
| owner: ctx.repo.owner, | |||
| repo: ctx.repo.repo, | |||
| name: CHECK_NAME, | |||
| head_sha: ctx.sha, | |||
| head_sha: ctx.payload.pull_request ? ctx.payload.pull_request.head.sha : ctx.sha, | |||
There was a problem hiding this comment.
Because if you use ctx.sha - it won't appear in the PR: actions/toolkit#133 (comment)
| @@ -71,7 +72,27 @@ const SeverityAnnotationLevelMap = new Map<RuleSeverity, "warning" | "failure">( | |||
| } else { | |||
| const linter = new Linter(options); | |||
|
|
|||
| const files = glob.sync(pattern!); | |||
| let files = glob.sync(pattern!); | |||
There was a problem hiding this comment.
It would be nice if this block can be cleaned.
e.g.
const files = await (async () => {
const matched = glob.sync(pattern!);
if (!onlyChanged) {
return matched;
}
const changedFiles = ctx.action === "pull_request" ?
(await octokit.pulls.listFiles(options)).data :
await getChangedFilesSomeHow();
return matched.filter((f) => changedFiles.includes(f));
})();There was a problem hiding this comment.
Why is this better? We are already in async function.
| const changedFiles = response.data.map((f) => f.filename); | ||
| files = files.filter((f: string) => changedFiles.includes(f)); | ||
| } else { | ||
| const response = await octokit.repos.getCommit({ |
There was a problem hiding this comment.
It won't get changed files correctly if user pushed multiple commits
There was a problem hiding this comment.
All you have is ctx.sha so this should work OK.
| @@ -122,6 +145,10 @@ const SeverityAnnotationLevelMap = new Map<RuleSeverity, "warning" | "failure">( | |||
| annotations, | |||
| }, | |||
| }); | |||
|
|
|||
| if (result.errorCount) { | |||
| core.setFailed(`${result.errorCount} error(s), ${result.warningCount} warning(s) found`); | |||
| @@ -19,6 +19,7 @@ const SeverityAnnotationLevelMap = new Map([ | |||
| const projectFileName = core.getInput("project"); | |||
| const pattern = core.getInput("pattern"); | |||
| const ghToken = core.getInput("token"); | |||
| const onlyChanged = core.getInput("only-changed") || false; | |||
There was a problem hiding this comment.
This file will be automatically updated. You don't have to change this file
There was a problem hiding this comment.
I know - but without compiled file - I cannot test this branch in my project
mooyoul
added
enhancement
|
Any updates on this? |
|
Hello @aaomidi, As you can see, I left a review of this PR and I will merge this if author updates PR with requested changes. |
|
Alright, I might make a PR that fixes this - would that be okay? |
|
Sounds great! It would be nice if you make a new PR 👍 |
|
@aaomidi Did you make any progress on the new PR? I'm excited to see this feature land. |
|
Right now I've made my own repo building up on this. I eventually plan to PR back here, just haven't had the time :/ @mooyoul would you mind if the PR changed this from JS to TS too? |
|
Hello there, I’m looking into this. Stay tuned! |
Hi, I wanted to lint only files which has been changed in the Pull Request, so I added
only-changedoption.