license
Check and fix Apache 2.0 license headers and dependency licenses using skywalking-eyes. Use before submitting a PR.
- License 许可
- Apache-2.0
- 最近更新
- 2026-11-11
- Stars
- ★ 2.5w
- Forks
- 6.6k
01 前言 Front Matter
- name
- license
- description
- Check and fix Apache 2.0 license headers and dependency licenses using skywalking-eyes. Use before submitting a PR.
- argument-hint
- [check|fix|deps]
03 SKILL.md 正文
License Checks
Check and fix license compliance using skywalking-eyes. Two CI jobs use this tool:
- license-header — verifies all source files have Apache 2.0 headers
- dependency-license — verifies the LICENSE file matches current dependencies
Steps
Header check (default, or check argument)
license-eye header check
- All valid: Output shows
valid: N, invalid: 0— nothing to do. - Invalid files found: Fix with
license-eye header fix, then re-check.
Header fix (fix argument)
license-eye header fix
license-eye header check
Dependency license check (deps argument)
This regenerates the LICENSE file from dependency metadata and checks for drift:
license-eye dependency resolve --summary ./dist-material/release-docs/LICENSE.tpl || exit 1
if [ ! -z "$(git diff -U0 ./dist-material/release-docs/LICENSE)" ]; then
echo "LICENSE file is not updated correctly"
git diff -U0 ./dist-material/release-docs/LICENSE
fi
If the LICENSE file changed, review the diff and commit it. Important: CI runs on Linux — some dependencies have platform-specific variants. If you're on macOS/Windows, the LICENSE diff may be a platform artifact. Verify before committing.
Rules
Configuration is in .licenserc.yaml:
- Java, XML, YAML/YML files require Apache 2.0 headers
- JSON and Markdown files are excluded (JSON doesn't support comments)
- Generated files and certain vendor paths are excluded
- SPI service files (
META-INF/services/) require headers (use#comment style)
Installation
# Same version as CI (pinned commit)
go install github.com/apache/skywalking-eyes/cmd/license-eye@5b7ee1731d036b5aac68f8bd3fc9e6f98ada082e
# Or via Homebrew (macOS)
brew install license-eye
04 同仓库更多 Skills
test
Run unit tests, integration tests, or slow integration tests matching CI. Use to validate changes before submitting a PR.
run-e2e
Run SkyWalking E2E tests locally
package
Rebuild the SkyWalking distribution and OAP Docker image after source changes. Use before running e2e tests so the image reflects your code changes. Avoids the "image looks updated but runtime has stale jars" trap.
new-monitoring-feature
Add a new monitoring target / layer to SkyWalking OAP. Orients you to the OAL / MAL / LAL / TAL / SpanListener extension points, the UI template + submodule touchpoints, the docs set that must move together, and the cross-cutting traps that don't live in any one skill.
gh-pull-request
Verify, commit, and push changes on a PR branch. Runs pre-flight checks (compile, checkstyle, license headers) before every push. Also creates the PR if one doesn't exist yet.
generate-classes
Generate bytecode classes from DSL scripts (MAL, OAL, LAL, Hierarchy). Runs the compiler and dumps .class files for inspection.