addlicense

(★ 884)

A program which ensures source code files have copyright license headers by scanning directory patterns recursively

  • .gitignore
  • .golangci.yaml
  • .goreleaser.yaml
  • .pre-commit-hooks.yaml
  • CONTRIBUTING.md
  • Dockerfile
  • go.mod
  • go.sum
  • LICENSE
  • main.go
  • main_test.go
  • README.md
  • RELEASING.md
  • tmpl.go
  • tmpl_test.go

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/google/addlicense

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

cd addlicense

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

2. 공식 설치 스크립트

쉬움 추천
사전 준비물
  • Go go install 명령어를 쓰려면 Go가 필요합니다.
go install github.com/google/addlicense@latest

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

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

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

3. Docker

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
docker pull ghcr.io/google/addlicense:latest

이 명령어를 터미널에 그대로 입력해 실행하세요.

docker build -t ghcr.io/google/addlicense .

Dockerfile을 기반으로 실행 가능한 이미지를 빌드합니다.

docker run -it ghcr.io/google/addlicense -h

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

docker run -it -v ${PWD}:/src ghcr.io/google/addlicense -c "Google LLC" *.go

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

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

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

4. Go

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

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

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

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

5. Ruby

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Ruby bundle 명령어를 쓰려면 Ruby가 필요합니다.
⚠️ 이 프로젝트는 규모가 큰 저장소라, 이 방법이 실제 핵심 제품이 아니라 내부 하위 패키지를 가리키는 것일 수 있습니다. README 전체를 함께 확인해보세요.
cd testdata/expected

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

bundle install

Gemfile에 명시된 루비 라이브러리를 설치합니다.

bundle install이 에러 없이 끝나면 README에 안내된 실행 명령어(예: rails server)로 마저 실행해보세요.
// repository documentation