Release v3.1.0

- Add PR comment minimization functionality with GraphQL
- Fix lint errors and improve test coverage
- Update release script for automatic GitHub releases
- Update changelog and version

Author: villelahdenvuo

CHANGELOG.md

@@ -2,6 +2,21 @@
 
 # Changelog
 
+## [3.1.0] - 2025-12-30
+
+### Added
+
+- Added PR comment minimization functionality to hide previous bot comments before creating new ones
+- Added comprehensive GraphQL support for PR comment management with pagination
+- Enhanced release script to automatically create GitHub releases with auto-generated notes
+- Added repository detection from git remote URL in release script
+
+### Fixed
+
+- Fixed lint errors by allowing 'any' types in test files
+- Added comprehensive test coverage for edge cases including pagination failures and API errors
+- Improved error handling in PR comment operations
+
 ## [3.0.1] - 2025-12-30
 
 ### Fixed

__tests__/main.test.ts

@@ -58,7 +58,6 @@ await jest.unstable_mockModule('@actions/github', async () => {
 			payload: {},
 			repo: { owner: 'test-owner', repo: 'test-repo' },
 		},
-		// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	} as any;
 });
 
@@ -83,9 +82,11 @@ let setOutputMock: jest.Mock;
 let mockOctokit: {
 	rest: {
 		issues: {
-			createComment: jest.Mock;
+			createComment: jest.Mock<any>;
+			listComments: jest.Mock<any>;
 		};
 	};
+	graphql: jest.Mock<any>;
 };
 
 describe('action', () => {
@@ -140,8 +141,10 @@ describe('action', () => {
 			rest: {
 				issues: {
 					createComment: jest.fn(),
+					listComments: jest.fn(),
 				},
 			},
+			graphql: jest.fn(),
 		};
 		githubMocks.getOctokit.mockReturnValue(mockOctokit);
 	});
@@ -406,9 +409,41 @@ at Tests.Registration.main(Registration.java:202)`,
 		};
 		testInputs.reports = ['junit|fixtures/junit-many-errors.xml'];
 		testInputs['max-annotations'] = '2';
-		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		(mockOctokit.rest.issues.createComment as any).mockResolvedValue({});
+		// Mock listComments to return some previous bot comments
+		mockOctokit.rest.issues.listComments.mockResolvedValue({
+			data: [
+				{
+					id: 1,
+					node_id: 'comment1',
+					body: '## Skipped Annotations\n\nOld comment',
+				},
+				{
+					id: 2,
+					node_id: 'comment2',
+					body: 'Some other comment',
+				},
+			],
+		});
+		// Mock graphql for minimizing comments
+		mockOctokit.graphql.mockResolvedValue({});
+		mockOctokit.rest.issues.createComment.mockResolvedValue({});
 		await main.run();
+		expect(mockOctokit.rest.issues.listComments).toHaveBeenCalledWith({
+			owner: 'test-owner',
+			repo: 'test-repo',
+			issue_number: 123,
+			page: 1,
+			per_page: 100,
+		});
+		expect(mockOctokit.graphql).toHaveBeenCalledWith(
+			expect.stringContaining('MinimizeComment'),
+			{
+				input: {
+					subjectId: 'comment1',
+					classifier: 'OUTDATED',
+				},
+			},
+		);
 		expect(mockOctokit.rest.issues.createComment).toHaveBeenCalledWith({
 			owner: 'test-owner',
 			repo: 'test-repo',
@@ -427,15 +462,109 @@ at Tests.Registration.main(Registration.java:202)`,
 		};
 		testInputs.reports = ['junit|fixtures/junit-many-errors.xml'];
 		testInputs['max-annotations'] = '2';
+		// Mock listComments
+		mockOctokit.rest.issues.listComments.mockResolvedValue({
+			data: [],
+		});
+		// Mock graphql
+		mockOctokit.graphql.mockResolvedValue({});
 		const apiError = new Error('API Error');
-		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		(mockOctokit.rest.issues.createComment as any).mockRejectedValue(apiError);
+		mockOctokit.rest.issues.createComment.mockRejectedValue(apiError);
 		await main.run();
 		expect(errorMock).toHaveBeenCalledWith(
 			`Failed to create PR comment: ${apiError}`,
 		);
 	});
 
+	it('should handle pagination when fetching comments', async () => {
+		// Mock GitHub context to be on a PR
+		(github.context as MutableContext).payload = {
+			pull_request: { number: 123 },
+		};
+		testInputs.reports = ['junit|fixtures/junit-many-errors.xml'];
+		testInputs['max-annotations'] = '2';
+		// Mock listComments to return full page on first call, then empty page
+		mockOctokit.rest.issues.listComments
+			.mockResolvedValueOnce({
+				data: Array(100)
+					.fill(null)
+					.map((_, i) => ({
+						id: i + 1,
+						node_id: `comment${i + 1}`,
+						body: '## Skipped Annotations\n\nOld comment',
+					})),
+			})
+			.mockResolvedValueOnce({
+				data: [],
+			});
+		// Mock graphql for minimizing comments
+		mockOctokit.graphql.mockResolvedValue({});
+		mockOctokit.rest.issues.createComment.mockResolvedValue({});
+		await main.run();
+		expect(mockOctokit.rest.issues.listComments).toHaveBeenCalledTimes(2);
+		expect(mockOctokit.rest.issues.listComments).toHaveBeenCalledWith({
+			owner: 'test-owner',
+			repo: 'test-repo',
+			issue_number: 123,
+			page: 1,
+			per_page: 100,
+		});
+		expect(mockOctokit.rest.issues.listComments).toHaveBeenCalledWith({
+			owner: 'test-owner',
+			repo: 'test-repo',
+			issue_number: 123,
+			page: 2,
+			per_page: 100,
+		});
+		expect(mockOctokit.graphql).toHaveBeenCalledTimes(100);
+	});
+
+	it('should handle GraphQL minimization failure for individual comments', async () => {
+		// Mock GitHub context to be on a PR
+		(github.context as MutableContext).payload = {
+			pull_request: { number: 123 },
+		};
+		testInputs.reports = ['junit|fixtures/junit-many-errors.xml'];
+		testInputs['max-annotations'] = '2';
+		// Mock listComments to return bot comments
+		mockOctokit.rest.issues.listComments.mockResolvedValue({
+			data: [
+				{
+					id: 1,
+					node_id: 'comment1',
+					body: '## Skipped Annotations\n\nOld comment',
+				},
+			],
+		});
+		// Mock graphql to fail for minimization
+		const graphqlError = new Error('GraphQL Error');
+		mockOctokit.graphql.mockRejectedValue(graphqlError);
+		mockOctokit.rest.issues.createComment.mockResolvedValue({});
+		await main.run();
+		expect(warningMock).toHaveBeenCalledWith(
+			'Failed to minimize comment 1: Error: GraphQL Error',
+		);
+		expect(mockOctokit.rest.issues.createComment).toHaveBeenCalled();
+	});
+
+	it('should handle listComments API failure', async () => {
+		// Mock GitHub context to be on a PR
+		(github.context as MutableContext).payload = {
+			pull_request: { number: 123 },
+		};
+		testInputs.reports = ['junit|fixtures/junit-many-errors.xml'];
+		testInputs['max-annotations'] = '2';
+		// Mock listComments to fail
+		const apiError = new Error('API Error');
+		mockOctokit.rest.issues.listComments.mockRejectedValue(apiError);
+		mockOctokit.rest.issues.createComment.mockResolvedValue({});
+		await main.run();
+		expect(warningMock).toHaveBeenCalledWith(
+			'Failed to minimize previous bot comments: Error: API Error',
+		);
+		expect(mockOctokit.rest.issues.createComment).toHaveBeenCalled();
+	});
+
 	it('should throw error for invalid report format', async () => {
 		testInputs.reports = ['invalid-format-no-pipe'];
 		await expect(main.run()).rejects.toThrow(

dist/index.js

@@ -82,4 +82,10 @@ export default [
 			'prettier/prettier': 'error',
 		},
 	},
+	{
+		files: ['__tests__/**/*.ts'],
+		rules: {
+			'@typescript-eslint/no-explicit-any': 'off',
+		},
+	},
 ];

dist/index.js.map

@@ -1,7 +1,7 @@
 {
 	"name": "report-annotate",
 	"description": "Annotate PR from report e.g. junit",
-	"version": "3.0.1",
+	"version": "3.1.0",
 	"author": "",
 	"type": "module",
 	"private": true,

eslint.config.mjs

@@ -24,6 +24,7 @@ set -e
 # 8. Point separate major release tag (e.g. v1, v2) to the new release
 # 9. Push the new tags (with commits, if any) to remote
 # 10. If this is a major release, create a 'releases/v#' branch and push
+# 11. Create a GitHub release with auto-generated release notes
 #
 # Usage:
 #
@@ -129,5 +130,57 @@ if [ $is_major_release = 'yes' ]; then
 	echo -e "Branch: ${BOLD_GREEN}releases/$new_major_release_tag${OFF} pushed to remote"
 fi
 
+# 11. Create a GitHub release
+echo -e "Creating GitHub release for ${BOLD_BLUE}$new_tag${OFF}..."
+
+# Get repository information from git remote
+if ! remote_url=$(git remote get-url origin 2>/dev/null); then
+	echo -e "${BOLD_RED}Failed to get git remote URL. Please ensure you're in a git repository with an 'origin' remote.${OFF}"
+	exit 1
+fi
+
+# Extract owner/repo from remote URL
+# Handle both HTTPS and SSH formats:
+# https://github.com/owner/repo.git -> owner/repo
+# git@github.com:owner/repo.git -> owner/repo
+if [[ $remote_url =~ github\.com[/:]([^/]+)/([^/.]+) ]]; then
+	repo_owner="${BASH_REMATCH[1]}"
+	repo_name="${BASH_REMATCH[2]}"
+	github_repository="$repo_owner/$repo_name"
+	echo -e "Detected repository: ${BOLD_BLUE}$github_repository${OFF}"
+else
+	echo -e "${BOLD_RED}Could not parse repository information from git remote URL: $remote_url${OFF}"
+	echo -e "Expected format: https://github.com/owner/repo or git@github.com:owner/repo"
+	exit 1
+fi
+
+# Check if gh CLI is available
+if ! command -v gh &> /dev/null; then
+	echo -e "${BOLD_RED}GitHub CLI (gh) is not installed. Please install it to create releases automatically.${OFF}"
+	echo -e "You can manually create the release at: https://github.com/$github_repository/releases/new"
+	echo -e "Tag: ${BOLD_BLUE}$new_tag${OFF}"
+	exit 1
+fi
+
+# Check if user is authenticated with GitHub CLI
+if ! gh auth status &> /dev/null; then
+	echo -e "${BOLD_RED}Not authenticated with GitHub CLI. Please run 'gh auth login' first.${OFF}"
+	echo -e "You can manually create the release at: https://github.com/$github_repository/releases/new"
+	echo -e "Tag: ${BOLD_BLUE}$new_tag${OFF}"
+	exit 1
+fi
+
+# Generate release notes automatically
+echo -e "Generating release notes..."
+if gh release create "$new_tag" --generate-notes --draft --repo "$github_repository"; then
+	echo -e "Draft release created: ${BOLD_GREEN}$new_tag${OFF}"
+	echo -e "Please review and publish the release at: https://github.com/$github_repository/releases"
+else
+	echo -e "${BOLD_RED}Failed to create GitHub release.${OFF}"
+	echo -e "You can manually create the release at: https://github.com/$github_repository/releases/new"
+	echo -e "Tag: ${BOLD_BLUE}$new_tag${OFF}"
+	exit 1
+fi
+
 # Completed
 echo -e "${BOLD_GREEN}Done!${OFF}"