Skip to content

Include license in Go module - #123

Merged
shps951023 merged 1 commit into
mainfrom
fix/go-module-license
Sep 3, 2026
Merged

shps951023 merged 1 commit into
mainfrom
fix/go-module-license

Conversation

@shps951023

@shps951023 shps951023 commented Sep 3, 2026

Copy link
Copy Markdown
Member

Summary

  • add the Apache 2.0 license inside the minipdf-go submodule
  • allow pkg.go.dev to classify the module as redistributable and display API documentation

Context

minipdf-go/v0.1.0 is available from the Go module proxy, but pkg.go.dev hides its documentation because repository-root license files are not included in a submodule archive. After merge, a minipdf-go/v0.1.1 tag will publish the corrected module archive.

Validation

  • verified standard Apache 2.0 license markers
  • git diff --check

Summary by CodeRabbit

  • Documentation
    • Added an Apache License 2.0 file with copyright attribution.

Add Apache 2.0 license text to the Go submodule so pkg.go.dev can display package documentation.
Copilot AI lite review requested due to automatic review settings September 3, 2026 16:10
@coderabbitai

coderabbitai Bot commented Sep 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: a09a4697-55d9-4157-add5-12d306abce07

📥 Commits

Reviewing files that changed from the base of the PR and between 97e1250 and 1fabc93.

📒 Files selected for processing (1)
  • minipdf-go/LICENSE

Included review availability: Your plan provides up to 2 included reviews per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The pull request adds minipdf-go/LICENSE with the complete Apache License, Version 2.0 text and copyright attribution to Wei Lin.

Changes

Project Licensing

Layer / File(s) Summary
Add Apache License
minipdf-go/LICENSE
Adds Apache License, Version 2.0 terms, including redistribution conditions, patent terms, disclaimers, liability limits, and attribution.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 1fabc

This adds the Apache 2.0 license file needed for module licensing metadata without changing runtime behavior. The change is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding a license to the Go module.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/go-module-license

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 Approval recommended

The change is limited to adding a standard license file in the correct Go module directory to address pkg.go.dev license detection.

Pull request overview

This PR adds an Apache 2.0 LICENSE file to the minipdf-go Go submodule so that the module archive published via the Go module proxy includes license metadata, enabling pkg.go.dev to show the module’s documentation and mark it as redistributable.

Changes:

  • Add minipdf-go/LICENSE containing the Apache 2.0 license text for the Go submodule.
File summaries
File Description
minipdf-go/LICENSE Adds a submodule-local Apache 2.0 license file so pkg.go.dev can detect licensing for minipdf-go.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@shps951023
shps951023 merged commit 676328b into main Sep 3, 2026
6 checks passed
@shps951023
shps951023 deleted the fix/go-module-license branch September 16, 2026 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants