skywalking-eyes

(★ 313)

A full-featured license tool to check and fix license headers and resolve dependencies' licenses.

  • .asf.yaml
  • .gitignore
  • .golangci.yml
  • .licenserc.yaml
  • action.yml
  • CHANGES.md
  • CONTRIBUTING.md
  • Dockerfile
  • go.mod
  • go.sum
  • LICENSE
  • Makefile
  • NOTICE
  • README.md

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/apache/skywalking-eyes

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd skywalking-eyes

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. 공식 설치 스크립트

쉬움 추천
사전 준비물
  • Go go install 명령어를 쓰려면 Go가 필요합니다.
  • Homebrew macOS/Linux용 패키지 매니저입니다.
go install github.com/apache/skywalking-eyes/cmd/license-eye@latest

지정된 버전을 바로 다운로드해서 설치합니다. 레포를 직접 클론할 필요가 없습니다.

brew install license-eye

Homebrew로 이미 빌드된 패키지를 바로 설치합니다. 소스 빌드가 필요 없습니다.

설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Docker

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header check

빌드된 이미지를 실제 컨테이너로 실행합니다.

docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix

빌드된 이미지를 실제 컨테이너로 실행합니다.

docker run -it --rm -v ${pwd}:/github/workspace apache/skywalking-eyes header check

빌드된 이미지를 실제 컨테이너로 실행합니다.

docker run -it --rm -v ${pwd}:/github/workspace apache/skywalking-eyes header fix

빌드된 이미지를 실제 컨테이너로 실행합니다.

docker run -it --rm -v $(pwd):/github/workspace ghcr.io/apache/skywalking-eyes/license-eye header check

빌드된 이미지를 실제 컨테이너로 실행합니다.

터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

4. Maven (Java)

보통
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • JDK (Java) Java 프로젝트를 빌드/실행하려면 필요합니다.
  • Maven mvn 명령어를 쓰기 위한 빌드 도구입니다.
⚠️ 이 프로젝트는 규모가 큰 저장소라, 이 방법이 실제 핵심 제품이 아니라 내부 하위 패키지를 가리키는 것일 수 있습니다. README 전체를 함께 확인해보세요.
cd pkg/deps/testdata/maven/base

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

mvn clean install

Maven으로 의존성 설치와 빌드를 진행합니다.

BUILD SUCCESS 메시지가 뜨면 성공입니다. target/ 폴더에 결과물이 생성됩니다.

5. Go

보통
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Go Go 언어 컴파일러 및 도구 모음입니다.
go install github.com/apache/skywalking-eyes/cmd/license-eye@latest

지정된 버전을 바로 다운로드해서 설치합니다. 레포를 직접 클론할 필요가 없습니다.

빌드가 에러 없이 끝나면 성공입니다. go run . 을 썼다면 터미널 출력을 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

6. Make

보통
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Make Linux/macOS는 보통 기본 설치되어 있습니다. Windows는 별도 설치(예: MSYS2, WSL)가 필요합니다.
make build

생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.

에러 없이 끝나면 성공입니다. 생성된 실행 파일을 직접 실행해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation