🎯 open source workflow를 생성하는 방법을 정리합니다.

📗 Today I Learned

오픈 소스 프로젝트 생성 실습

GitHub를 활용한 오픈 소스 프로젝트를 설정하고, 이를 관리하는 데 필요한 문서와 자동화 작업을 추가하는 실습을 합니다.

오픈소스 저장소 생성 및 브랜치 보호

먼저 GitHub에서 오픈 소스 프로젝트를 시작하려면, 새 저장소를 생성해야 합니다. 이번엔 Organization을 이용하여 새로운 저장소를 만들겠습니다.

1️⃣ GitHub에서 Organizations로 이동하여 New Organization 버튼을 클릭합니다.

2️⃣ Organization 이름, 이메일, 소속을 선택해 새 조직을 생성합니다.

3️⃣ New Repository를 클릭해 저장소를 생성합니다.

4️⃣ 저장소 생성 후, Settings > Branches에서 main 브랜치를 보호 설정합니다.

5️⃣ main 브랜치에 대한 Ruleset을 지정하고 보호 옵션을 설정합니다.

• Require a pull request before merging : 반드시 PR을 통해서만 main 브랜치에 병합이 가능합니다.

  • Dismiss stale pull request approvals when new commits are pushed : PR에 대한 승인이 완료된 후 새로운 커밋이 추가되면 기존 승인을 무효화합니다.

  • Require approval of the most recent reviewable push : 마지막으로 푸시된 커밋이 타인의 승인을 반드시 받아야 병합이 가능합니다.

  • Require conversation resolution before merging : PR에 작성된 모든 코멘트 대화(Conversation)가 해결되어야 병합할 수 있습니다.

---

오픈소스 문서 템플릿 생성

MINIDASH/
├── 📁 .github/                 
│   ├── 📁 ISSUE_TEMPLATE/      
│   │   ├── 📄 bug_report.md       
│   │   └── 📄 feature_request.md   
│   └── 📁 workflows/
│       └── 📄 workflow.yml       
├── 📁 src/                           
│   ├── 📄 capitalize.js
│   ├── 📄 checkArr.js 
│   ├── 📄 findEvenNums.js 
│   └── 📄 findOddNums.js
├── 📄 index.js   
├── 📄 README.md               
├── 📄 CONTRIBUTING.md         
├── 📄 CODE_OF_CONDUCT.md      
├── 📄 LICENSE                         
└── 📄 package.json            

---

GitHub Actions 설정

GitHub Actions를 사용하면 CI/CD를 자동화할 수 있습니다. 코드가 푸시될 때마다 테스트를 자동으로 실행하거나, 배포 작업을 자동화할 수 있습니다.

GitHub Actions를 설정하려면, 저장소 내에 .github/workflows 폴더를 만들고 그 안에 .yml 확장자를 가진 워크플로우 파일을 작성하면 됩니다.

이 워크플로우 파일을 생성하는 것 자체가 GitHub Actions 설정의 시작이며, 해당 파일을 통해 어떤 이벤트에 어떤 작업을 자동으로 실행할지 정의할 수 있습니다.

🤔 GitHub Actions란?
GitHub Actions는 GitHub에서 제공하는 자동화 도구로, 저장소 내에서 CI/CD(지속적 통합 및 지속적 배포) 파이프라인을 설정할 수 있습니다.

코드가 변경되면 자동으로 테스트, 빌드, 배포 등의 작업을 실행하여 개발 효율성과 코드 품질을 높일 수 있습니다.

• workflow.yml

Pull Request의 본문이 비어 있는지 자동으로 검사하고, 비어 있을 경우 안내 메시지를 남기고 PR을 자동으로 닫는 워크플로우 예시입니다.

name: Pull Request Check

on:
  pull_request:
    types: [opened, synchronize]

jobs:
  check:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write

    steps:
      - uses: actions/github-script@v7
        with:
          script: |

            async function run() {
              try {
                const pull_request = context.payload.pull_request;

                if (!pull_request) {
                  console.log("This is not a pull request.");
                  return;
                }

                const body = pull_request.body;

                if (!body || body.trim() === "") {
                  await github.rest.issues.createComment({
                    owner: context.repo.owner,
                    repo: context.repo.repo,
                    issue_number: pull_request.number,
                    body: "해당 PR은 가이드라인을 준수하지 않았습니다. 때문에 PR을 닫도록 하겠습니다. 가이드라인을 준수해서 다시 PR을 요청해주세요. 😊"
                  });

                  await github.rest.pulls.update({
                    owner: context.repo.owner,
                    repo: context.repo.repo,
                    pull_number: pull_request.number,
                    state: "closed"
                  });
                }
              } catch (error) {
                console.error("❌ 워크플로우 실행 중 오류 발생:", error.message);
              }
            }

            run();

• on : 이 섹션은 워크플로우가 실행될 트리거를 정의하는 부분입니다. push 또는 pull_request 이벤트가 발생했을 때 워크플로우가 실행되도록 설정할 수 있습니다. ( 만약 브랜치를 따로 지정하지 않으면, 모든 브랜치에서 해당 이벤트가 발생했을 때 워크플로우가 실행됩니다. )

• jobs : 워크플로우 안에서 실제로 실행되는 작업 단위입니다. 하나의 워크플로우는 여러 개의 job을 가질 수 있고, 각 job은 독립적으로 실행되거나 순서를 지정할 수 있습니다.

  • check : jobs 안에 정의된 하나의 작업(job) 이름입니다. 이 이름은 자유롭게 변경할 수 있으며, 워크플로우 내부에서 이 job을 식별할 때 사용됩니다.

    • runs-on : job을 실행할 때 사용할 가상 환경을 지정합니다.

    • permissions : 이 워크플로우가 GitHub API에 어떤 권한으로 접근할 수 있을지 설정합니다. 예를 들어 PR에 댓글을 달려면 pull-requests: write 권한이 필요합니다.

    • steps : 하나의 job 안에서 실제로 실행되는 작업 단계들을 순서대로 정의합니다. 각 step에는 외부 액션을 사용하거나 직접 명령어를 실행하는 내용이 들어갑니다.

      • uses : 외부에서 만들어진 GitHub Action을 가져와서 사용하는 구문입니다. actions/github-script@v7 를 사용해서 JavaScript 코드를 실행합니다.

      • with : uses 로 가져온 Action에 설정값이나 스크립트 등을 넘겨줄 때 사용합니다.

        • script : github-script 액션에서 실행할 실제 JavaScript 코드입니다. PR의 본문이 비어 있는지를 검사하고, 조건을 만족하지 않을 경우 자동으로 댓글을 달거나 PR을 닫는 등의 로직을 구현할 수 있습니다.

---

✏️ 회고

허용되지 않은 PR이 알아서 제지가 되는 것을 실습하면서 자동화가 실제로 행해지는 것을 보니 자동화가 얼마나 중요한 지 깨달은 하루였다.