zzugab/juice-shop-with-kubeadm-and-tfkubeadm 및 Terraform을 사용하여 Kubernetes에 OWASP Juice Shop을 자동 배포하고, DevSecOps 파이프라인을 위해 Trivy 취약점 스캐닝을 통합합니다.
GitLab을 시작하기 쉽도록 추천되는 다음 단계 목록입니다.
이미 프로이신가요? 이 README.md를 편집하여 자신만의 것으로 만드세요. 쉽게 만들고 싶으신가요? 하단의 템플릿을 사용하세요!
cd existing_repo
git remote add origin https://gitlab.com/zzugab/juice-shop-with-kubeadm-and-tf.git
git branch -M main
git push -uf origin main
GitLab의 내장된 지속적 통합을 사용하세요.
이 README를 자신의 것으로 만들 준비가 되셨나요? 이 파일을 편집하고 아래의 편리한 템플릿을 사용하세요(또는 원하는 대로 자유롭게 구조화하세요 - 이것은 단지 시작점일 뿐입니다!). 이 템플릿을 제공해 주신 makeareadme.com에 감사드립니다.
모든 프로젝트는 다르므로, 이 섹션 중 어떤 것이 자신의 프로젝트에 적용되는지 고려하세요. 템플릿에 사용된 섹션은 대부분의 오픈 소스 프로젝트를 위한 제안입니다. 또한 README가 너무 길고 상세할 수 있지만, 너무 긴 것이 너무 짧은 것보다 낫다는 점을 명심하세요. README가 너무 길다고 생각되면, 정보를 생략하는 대신 다른 형태의 문서를 활용하는 것이 좋습니다.
프로젝트 이름은 자명하게 선택하세요.
사람들에게 프로젝트가 구체적으로 무엇을 할 수 있는지 알려주세요. 맥락을 제공하고 방문자가 익숙하지 않을 수 있는 참조 링크를 추가하세요. 기능 목록이나 배경 하위 섹션도 여기에 추가할 수 있습니다. 프로젝트에 대안이 있다면, 차별화 요소를 나열하기 좋은 장소입니다.
일부 README에서는 프로젝트의 모든 테스트 통과 여부와 같은 메타데이터를 전달하는 작은 이미지를 볼 수 있습니다. Shields를 사용하여 README에 배지를 추가할 수 있습니다. 많은 서비스에서 배지를 추가하는 방법에 대한 지침도 제공합니다.
무엇을 만들고 있는지에 따라 스크린샷이나 비디오를 포함하는 것이 좋습니다(실제 비디오보다 GIF를 자주 볼 수 있습니다). ttygif와 같은 도구가 도움이 될 수 있지만, 더 정교한 방법으로 Asciinema를 확인해보세요.
특정 생태계 내에서는 Yarn, NuGet, Homebrew와 같은 일반적인 설치 방법이 있을 수 있습니다. 그러나 README를 읽는 사람이 초보자이며 더 많은 지침을 원할 가능성을 고려하세요. 구체적인 단계를 나열하면 모호함을 없애고 사람들이 가능한 한 빨리 프로젝트를 사용할 수 있게 합니다. 특정 프로그래밍 언어 버전이나 운영체제와 같은 특정 컨텍스트에서만 실행되거나 수동으로 설치해야 하는 의존성이 있는 경우 요구 사항 하위 섹션도 추가하세요.
예제를 자유롭게 사용하고 가능하면 예상 출력을 보여주세요. README에 포함하기에는 너무 긴 고급 예제에 대한 링크를 제공하면서, 시연할 수 있는 가장 작은 사용 예제를 인라인으로 포함하는 것이 유용합니다.
사람들이 도움을 받을 수 있는 곳을 알려주세요. 이슈 트래커, 채팅방, 이메일 주소 등 어떤 조합이든 가능합니다.
향후 릴리스에 대한 아이디어가 있다면 README에 나열하는 것이 좋습니다.
기여를 받을 의향이 있는지, 그리고 기여를 수락하기 위한 요구 사항을 명시하세요.
프로젝트를 변경하려는 사람들을 위해 시작하는 방법에 대한 문서가 있으면 도움이 됩니다. 실행해야 할 스크립트나 설정해야 할 환경 변수가 있을 수 있습니다. 이러한 단계를 명확히 하세요. 이 지침은 미래의 자신에게도 유용할 수 있습니다.
코드 린트나 테스트 실행 명령도 문서화할 수 있습니다. 이러한 단계는 높은 코드 품질을 보장하고 변경 사항이 실수로 무언가를 손상시킬 가능성을 줄이는 데 도움이 됩니다. 테스트 실행 지침은 특히 브라우저 테스트를 위해 Selenium 서버 시작과 같은 외부 설정이 필요한 경우 매우 유용합니다.
프로젝트에 기여한 사람들에게 감사를 표하세요.
오픈 소스 프로젝트의 경우 라이선스 방식을 명시하세요.
프로젝트에 대한 에너지나 시간이 부족하다면 README 상단에 개발 속도가 느려졌거나 완전히 중단되었음을 알리는 메모를 추가하세요. 누군가가 프로젝트를 포크하거나 유지보수자 또는 소유자로 자원하여 프로젝트를 계속 진행할 수 있습니다. 유지보수자를 명시적으로 요청할 수도 있습니다.