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

fix: Limit number of labels added to 100 #497

Merged
merged 23 commits into from
Jun 21, 2023
Merged

fix: Limit number of labels added to 100 #497

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
756f0bd
push to excess labels to avoid reaching the limit
markmssd Feb 2, 2023
e4e6956
build dist
markmssd Feb 2, 2023
7429fbb
never set more than 100 labels
markmssd Mar 21, 2023
e173de7
use splice instead of set
markmssd Mar 21, 2023
56b1a22
Merge branch 'main' into fix/max-100-labels
markmssd Apr 18, 2023
f90e3c3
Merge branch 'main' into fix/max-100-labels
markmssd Jun 8, 2023
0e55d23
ignore IDE folders
markmssd Jun 8, 2023
4beee0f
install @octokit/plugin-retry
markmssd Jun 8, 2023
267e6ba
always setLabels
markmssd Jun 8, 2023
b35f25a
fix indentations
markmssd Jun 8, 2023
5baeff5
fix specs
markmssd Jun 8, 2023
d65a48d
add spec for excess labels
markmssd Jun 8, 2023
4dd2b81
prettier
markmssd Jun 12, 2023
2f9caa0
licensed cache
markmssd Jun 12, 2023
112b189
revert to !!core.getInput('sync-labels')
markmssd Jun 13, 2023
3d7acab
better warning for exceeded labels
markmssd Jun 13, 2023
92a11d8
keep manually-added labels
markmssd Jun 13, 2023
ffc8ca7
nest the dedupe logic
markmssd Jun 13, 2023
3c2f134
rename `removeLabel` to `removeLabelFromList` to avoid confusion
markmssd Jun 15, 2023
66f07b8
Merge branch 'main' into fix/max-100-labels
unrealclouder Jun 19, 2023
287ce90
use Sets, and issue a call only if labels have actually changed
unrealclouder Jun 20, 2023
05a4b4b
remove IDE config folders from gitignore
unrealclouder Jun 20, 2023
c9ee1b4
remove obsolete duplucation check
unrealclouder Jun 20, 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
4 changes: 3 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.DS_Store
node_modules/
lib/
lib/
.vscode/
.idea/
Copy link

Choose a reason for hiding this comment

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

Till the moment the IDE settings were avoided to be added to the repo

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh I can remove them haha, it was just getting annoying locally

2 changes: 1 addition & 1 deletion .licenses/npm/@octokit/openapi-types.dep.yml → ...pm/@octokit/openapi-types-12.11.0.dep.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 20 additions & 0 deletions .licenses/npm/@octokit/openapi-types-17.2.0.dep.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

34 changes: 34 additions & 0 deletions .licenses/npm/@octokit/plugin-retry.dep.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .licenses/npm/@octokit/types.dep.yml → .licenses/npm/@octokit/types-6.41.0.dep.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 20 additions & 0 deletions .licenses/npm/@octokit/types-9.2.3.dep.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

31 changes: 31 additions & 0 deletions .licenses/npm/bottleneck.dep.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions __mocks__/@actions/github.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ export const context = {
const mockApi = {
rest: {
issues: {
addLabels: jest.fn(),
removeLabel: jest.fn()
setLabels: jest.fn()
},
pulls: {
get: jest.fn().mockResolvedValue({}),
Expand Down
103 changes: 83 additions & 20 deletions __tests__/main.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ jest.mock('@actions/core');
jest.mock('@actions/github');

const gh = github.getOctokit('_');
const addLabelsMock = jest.spyOn(gh.rest.issues, 'addLabels');
const removeLabelMock = jest.spyOn(gh.rest.issues, 'removeLabel');
const setLabelsMock = jest.spyOn(gh.rest.issues, 'setLabels');
const reposMock = jest.spyOn(gh.rest.repos, 'getContent');
const paginateMock = jest.spyOn(gh, 'paginate');
const getPullMock = jest.spyOn(gh.rest.pulls, 'get');
const coreWarningMock = jest.spyOn(core, 'warning');

const yamlFixtures = {
'only_pdfs.yml': fs.readFileSync('__tests__/fixtures/only_pdfs.yml')
Expand Down Expand Up @@ -41,12 +41,16 @@ describe('run', () => {
configureInput({});
usingLabelerConfigYaml('only_pdfs.yml');
mockGitHubResponseChangedFiles('foo.pdf');
getPullMock.mockResolvedValue(<any>{
data: {
labels: []
}
});

await run();

expect(removeLabelMock).toHaveBeenCalledTimes(0);
expect(addLabelsMock).toHaveBeenCalledTimes(1);
expect(addLabelsMock).toHaveBeenCalledWith({
expect(setLabelsMock).toHaveBeenCalledTimes(1);
expect(setLabelsMock).toHaveBeenCalledWith({
owner: 'monalisa',
repo: 'helloworld',
issue_number: 123,
Expand All @@ -58,12 +62,16 @@ describe('run', () => {
configureInput({dot: true});
usingLabelerConfigYaml('only_pdfs.yml');
mockGitHubResponseChangedFiles('.foo.pdf');
getPullMock.mockResolvedValue(<any>{
data: {
labels: []
}
});

await run();

expect(removeLabelMock).toHaveBeenCalledTimes(0);
expect(addLabelsMock).toHaveBeenCalledTimes(1);
expect(addLabelsMock).toHaveBeenCalledWith({
expect(setLabelsMock).toHaveBeenCalledTimes(1);
expect(setLabelsMock).toHaveBeenCalledWith({
owner: 'monalisa',
repo: 'helloworld',
issue_number: 123,
Expand All @@ -75,11 +83,21 @@ describe('run', () => {
configureInput({});
usingLabelerConfigYaml('only_pdfs.yml');
mockGitHubResponseChangedFiles('.foo.pdf');
getPullMock.mockResolvedValue(<any>{
data: {
labels: []
}
});

await run();

expect(removeLabelMock).toHaveBeenCalledTimes(0);
expect(addLabelsMock).toHaveBeenCalledTimes(0);
expect(setLabelsMock).toHaveBeenCalledTimes(1);
expect(setLabelsMock).toHaveBeenCalledWith({
owner: 'monalisa',
repo: 'helloworld',
issue_number: 123,
labels: []
});
});

it('(with dot: true) does not add labels to PRs that do not match our glob patterns', async () => {
Expand All @@ -89,8 +107,13 @@ describe('run', () => {

await run();

expect(removeLabelMock).toHaveBeenCalledTimes(0);
expect(addLabelsMock).toHaveBeenCalledTimes(0);
expect(setLabelsMock).toHaveBeenCalledTimes(1);
expect(setLabelsMock).toHaveBeenCalledWith({
owner: 'monalisa',
repo: 'helloworld',
issue_number: 123,
labels: []
});
});

it('(with sync-labels: true) it deletes preexisting PR labels that no longer match the glob pattern', async () => {
Expand All @@ -104,19 +127,18 @@ describe('run', () => {
mockGitHubResponseChangedFiles('foo.txt');
getPullMock.mockResolvedValue(<any>{
data: {
labels: [{name: 'touched-a-pdf-file'}]
labels: [{name: 'touched-a-pdf-file'}, {name: 'manually-added'}]
}
});

await run();

expect(addLabelsMock).toHaveBeenCalledTimes(0);
expect(removeLabelMock).toHaveBeenCalledTimes(1);
expect(removeLabelMock).toHaveBeenCalledWith({
expect(setLabelsMock).toHaveBeenCalledTimes(1);
expect(setLabelsMock).toHaveBeenCalledWith({
owner: 'monalisa',
repo: 'helloworld',
issue_number: 123,
name: 'touched-a-pdf-file'
labels: ['manually-added']
});
});

Expand All @@ -131,14 +153,55 @@ describe('run', () => {
mockGitHubResponseChangedFiles('foo.txt');
getPullMock.mockResolvedValue(<any>{
data: {
labels: [{name: 'touched-a-pdf-file'}]
labels: [{name: 'touched-a-pdf-file'}, {name: 'manually-added'}]
}
});

await run();

expect(addLabelsMock).toHaveBeenCalledTimes(0);
expect(removeLabelMock).toHaveBeenCalledTimes(0);
expect(setLabelsMock).toHaveBeenCalledTimes(1);
expect(setLabelsMock).toHaveBeenCalledWith({
owner: 'monalisa',
repo: 'helloworld',
issue_number: 123,
labels: ['touched-a-pdf-file', 'manually-added']
});
});

it('(with sync-labels: false) it sets only 100 labels and logs the rest', async () => {
configureInput({
'repo-token': 'foo',
'configuration-path': 'bar',
'sync-labels': false
});

usingLabelerConfigYaml('only_pdfs.yml');
mockGitHubResponseChangedFiles('foo.pdf');

const existingLabels = Array.from({length: 100}).map((_, idx) => ({
name: `existing-label-${idx}`
}));
getPullMock.mockResolvedValue(<any>{
data: {
labels: existingLabels
}
});

await run();

expect(setLabelsMock).toHaveBeenCalledTimes(1);
expect(setLabelsMock).toHaveBeenCalledWith({
owner: 'monalisa',
repo: 'helloworld',
issue_number: 123,
labels: existingLabels.map(label => label.name)
});

expect(coreWarningMock).toHaveBeenCalledTimes(1);
expect(coreWarningMock).toHaveBeenCalledWith(
'Maximum of 100 labels allowed. Excess labels: touched-a-pdf-file',
{title: 'Label limit for a PR exceeded'}
);
});
});

Expand Down
Loading