feat: implement license section generation with GitHub API integration and core license service by Copilot · Pull Request #34 · hoverkraft-tech/ci-dokumentor

Copilot · 2025-08-07T07:52:12Z

This PR implements automatic license section generation that fetches actual license information from the GitHub API, replacing the previous hardcoded MIT license approach.

Key Features

GitHub API Integration

Fetches license information using GitHub's GraphQL API via existing Octokit infrastructure
Retrieves license name, SPDX identifier, and API URL
Integrates seamlessly with the existing GitHubRepositoryProvider

Enhanced License Section Output

Displays actual license name (e.g., "Apache License 2.0", "MIT License")
Includes SPDX identifier for compliance (e.g., SPDX-License-Identifier: Apache-2.0)
Links to official GitHub license API endpoints
Uses repository owner as fallback author when manifest author is unavailable

Core License Service Architecture

Created reusable LicenseService in core package for license detection logic
Moved license file detection from GitHubRepositoryProvider to dedicated service
Enables license detection to be shared across different repository providers
Clean separation of concerns following the existing architectural patterns

Smart Fallback System

Falls back to local license file detection when GitHub API is unavailable
Supports common license file names (LICENSE, LICENSE.txt, LICENSE.md, etc.)
Intelligent license type detection for MIT, Apache 2.0, GPL, BSD, and ISC licenses
No default license generation - returns empty section when no license information is found

Example Output

With GitHub API License:

## License
This project is licensed under the Apache License 2.0.

SPDX-License-Identifier: Apache-2.0

Copyright © 2025 Apache Foundation

For more details, see the [license](https://api.github.com/licenses/apache-2.0).

With Local License File:

## License
This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2025 Repository Owner

See the [LICENSE](LICENSE) file for full license text.

No License Information:
No license section is generated when no license information is available from either GitHub API or local files.

Implementation Details

Extended core Repository type to include optional license information
Enhanced GitHubRepositoryProvider with getLicenseInfo() method using GraphQL
Created dedicated LicenseService in core package for reusable license detection
Updated LicenseSectionGenerator to use repository license data without fallbacks
Added comprehensive test coverage for all scenarios
Maintains backward compatibility and follows existing code patterns

Fixes #33.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot · 2025-08-07T07:52:14Z

@neilime 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

Co-authored-by: neilime <314088+neilime@users.noreply.github.com>

neilime

@copilot Handle feedback

neilime · 2025-08-07T08:24:05Z

packages/cicd/github-actions/src/section/license-section-generator.adapter.ts

+        // Fallback to reading license file directly if no license info from GitHub
+        if (!licenseInfo) {
+            licenseInfo = this.getLicenseFromFile();
+        }


Fallback must implemented in packages/repository/github/src/github-repository.provider.ts

Moved the fallback logic to GitHubRepositoryProvider.getLicenseInfo() as requested. The repository provider now handles both GitHub API fetching and local file fallback, while the LicenseSectionGenerator is simplified to only use the repository license data. Commit aa0e1bb.

Co-authored-by: neilime <314088+neilime@users.noreply.github.com>

neilime

@copilot Fix feedbacks

neilime · 2025-08-07T08:43:40Z

packages/cicd/github-actions/src/section/license-section-generator.adapter.ts

Do not define default license

Removed the default license fallback. The license section generator now returns an empty buffer when no license information is available instead of defaulting to MIT license. Commit c77e28a.

neilime · 2025-08-07T08:46:19Z

packages/repository/github/src/github-repository.provider.ts

+        return this.getLicenseFromFile();
+    }
+
+    private getLicenseFromFile(): { name: string; spdxId: string | null; url: string | null } | undefined {


Move this to a core license service

Moved license detection logic to a new LicenseService in the core package. The GitHubRepositoryProvider now uses this service instead of implementing its own license detection. This creates a reusable service that can be used by other repository providers. Commit c77e28a.

…o core service Co-authored-by: neilime <314088+neilime@users.noreply.github.com>

Copilot · 2025-08-07T08:58:18Z

@copilot Fix feedbacks

Fixed both feedback items:

Removed default license fallback - license section generator now returns empty buffer when no license info is available
Moved license detection logic to new core LicenseService for better architecture

All changes tested and compiled successfully. Commit c77e28a.

neilime

@copilot handle feedbacks

neilime · 2025-08-07T09:03:40Z

packages/core/src/repository/license.service.ts

Add test for this new service

Added comprehensive tests for the LicenseService in packages/core/src/repository/license.service.spec.ts. The tests cover license file detection, content parsing for all supported license types (MIT, Apache 2.0, GPL v2/v3, BSD 2/3-Clause, ISC), SPDX ID mapping, and error handling scenarios. Commit 0d03318.

neilime · 2025-08-07T09:04:36Z

packages/repository/github/src/github-repository.provider.ts

    }
+
+    private async getLicenseInfo(repositoryInfo: Repository): Promise<{ name: string; spdxId: string | null; url: string | null } | undefined> {
+        try {


Do not try catch

Removed the try-catch block from the getLicenseInfo method. GitHub API errors will now bubble up naturally while maintaining the fallback to local license file detection when the API returns no license information. Commit 0d03318.

neilime · 2025-08-07T09:05:33Z

packages/repository/github/src/github-repository.provider.spec.ts

Improve tests for asserting license behavior

Enhanced the GitHubRepositoryProvider tests with comprehensive license behavior scenarios including GitHub API license fetching, fallback to LicenseService, error propagation, and edge cases like missing repository data. The tests now properly mock and validate the complete license detection workflow. Commit 0d03318.

…rvice tests, improve GitHubRepositoryProvider license tests Co-authored-by: neilime <314088+neilime@users.noreply.github.com>

Copilot · 2025-08-07T09:13:13Z

@copilot handle feedbacks

Addressed all feedback items:

✅ Removed try-catch from getLicenseInfo() method - errors now bubble up naturally
✅ Added comprehensive test suite for LicenseService covering all license types and edge cases
✅ Enhanced GitHubRepositoryProvider tests with detailed license behavior validation

All changes maintain the existing license detection workflow while improving error handling and test coverage. Commit 0d03318.

Initial plan

93ef5bd

Copilot AI assigned Copilot and neilime Aug 7, 2025

Copilot started work on behalf of neilime August 7, 2025 07:52 View session

Implement license section generation with GitHub API integration

7486aed

Co-authored-by: neilime <314088+neilime@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] feat: implement "license" section generation~~ feat: implement license section generation with GitHub API integration Aug 7, 2025

Copilot AI requested a review from neilime August 7, 2025 08:12

Copilot finished work on behalf of neilime August 7, 2025 08:12

neilime marked this pull request as ready for review August 7, 2025 08:21

neilime requested changes Aug 7, 2025

View reviewed changes

Copilot started work on behalf of neilime August 7, 2025 08:24 View session

Move license fallback logic to GitHubRepositoryProvider

aa0e1bb

Co-authored-by: neilime <314088+neilime@users.noreply.github.com>

Copilot finished work on behalf of neilime August 7, 2025 08:39

Copilot AI requested a review from neilime August 7, 2025 08:39

neilime requested changes Aug 7, 2025

View reviewed changes

Copilot started work on behalf of neilime August 7, 2025 08:46 View session

Address feedback: remove default license and move license detection t…

c77e28a

…o core service Co-authored-by: neilime <314088+neilime@users.noreply.github.com>

Copilot AI changed the title ~~feat: implement license section generation with GitHub API integration~~ feat: implement license section generation with GitHub API integration and core license service Aug 7, 2025

Copilot AI requested a review from neilime August 7, 2025 08:59

Copilot finished work on behalf of neilime August 7, 2025 08:59

neilime requested changes Aug 7, 2025

View reviewed changes

Copilot started work on behalf of neilime August 7, 2025 09:06 View session

Address feedback: remove try-catch from getLicenseInfo, add LicenseSe…

0d03318

…rvice tests, improve GitHubRepositoryProvider license tests Co-authored-by: neilime <314088+neilime@users.noreply.github.com>

Copilot AI requested a review from neilime August 7, 2025 09:14

Copilot finished work on behalf of neilime August 7, 2025 09:14

neilime approved these changes Aug 7, 2025

View reviewed changes

neilime merged commit 0670e4e into main Aug 7, 2025
13 of 15 checks passed

neilime deleted the copilot/fix-33 branch August 7, 2025 13:59

Uh oh!

Conversation

Copilot AI commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Key Features

Example Output

Implementation Details

Uh oh!

Copilot AI commented Aug 7, 2025

Uh oh!

neilime left a comment

Choose a reason for hiding this comment

Uh oh!

neilime Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

neilime left a comment

Choose a reason for hiding this comment

Uh oh!

neilime Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

neilime Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Aug 7, 2025

Uh oh!

neilime left a comment

Choose a reason for hiding this comment

Uh oh!

neilime Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

neilime Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

neilime Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Aug 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Aug 7, 2025 •

edited

Loading