[DBDocs] 문서화한 프로젝트의 관리 자동화

해당 글은 DBDocs에 대해서 사용을 해봤다는 가정 하에 포스트를 작성하였습니다. 이전에 포스트를 작성한 것이 있어 링크 같이 첨부합니다.

 

1. DBDiagram에 대해서 - DBML에 대해 알아야 하기떄문
2. DBDocs란? 사용법은? 

---

프로젝트의 막바지 무렵이 되서야 해당 문서화에 대해서 자동화 할 수 있는 것을 알게 된 부분이 아쉽긴 하지만 해보면 재밌을 것 같아 진행을 하게 되었다.

 

자동화 방법에 대해서는 DBDocs에서 튜토리얼에 소개된 대로 진행을 해보았다, 현재 진행했던 프로젝트역시 자동화를 Git Action으로 진행을 했었고 튜토리얼의 방법역시 Git Action을 활용하다 보니 바로 진행하게 되었다.

 

진행중인 프로젝트에 바로 넣을 까? 라는 생각을 했는데 그냥 Repository를 따로 제작하였다. 굳이 많은 수정을 하는 경우는 별로 없을듯해서...

 

내가 현재 자동화를 진행한 Repository는 아래 북마크를 들어가면 된다.

https://github.com/donsonioc2010/NooBLoL_DbDocs

GitHub - donsonioc2010/NooBLoL_DbDocs

 

Ps. 자동화 구축보다.. 문서화하는게 오래걸린것 같다 ㅋㅋ...

---

구축 방법

먼저 구축을 하는데 사용한 것은 Git Action을 사용하였다.

어떻게든 Script를 사용할 수 있다면 방법은 찾기 마련일 것이라 생각이 든다.

 

구축과정에서 Git Repository는 이미 있다고 가정하겠다.

 

 

1. Token의 생성

Git에서 Action을 통한 접근시 Token이 필요하다. 해당 키는 Secret이므로 일부 수정을 하였다.

주의에서 보듯 다시 못본다. 잊어먹으면 생성 다시해야하는 점..

dbdocs token -g
✔ Verify your identity.
✔ Your access token is: eyJhbGciOiJIUzI1NiIsI~~~BlaBla
 ›   Warning: Please save this token. You cannot see it again.

 

2. Git Action설정

아래의 사진이 보일지 모르겠다. Root의 경로에서 .github/workflows/{파일명}.yml을 제작하자.

프로젝트는 다음과 같이 설정 하였다.

# This is a basic workflow to help you get started with Actions
# 작업명
name: CI

# 작업이 진행되는 경우
on:
  # main브랜치에 push가 이뤄질경우
  push:
    branches: ["main"]
    
  # main브랜치에 PR이 발생하는 경우
  pull_request:
    branches: ["main"]

jobs:
  build:
  
 #Ubuntu
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      # DBDocs Install
      - name: Install dbdocs
        run: sudo npm install -g dbdocs

      #DBDocs Install Check
      - name: Check dbdocs
        run: dbdocs

      # Runs a set of commands using the runners shell
      - name: Update dbdocs project
      
		# 생성한 토큰의 설정 값을 직접 넣으면 다른사람도 보이므로 Git의 Secrets를 사용하자.
        env:
          DBDOCS_TOKEN: ${{ secrets.DBDOCS_TOKEN }}

		# Project명의 경우에는 설정해도 되고 안해도 상관없다.
        run: dbdocs build ./noob.dbml --project=${{ secrets.DBDOCS_PROJECT }}

 

3. Secret의 설정

 

프로젝트의 Settings → Secrets → Actions에서 설정이 가능하다.

생성의 경우에는 New Repository Secret를 사용해서 생성이 가능하다. 

나의 경우애는 Token과 Project를 설정하였기 떄문에 아래처럼 두개의 값에 대해서 설정을 진행하였다.

 

이후 main브랜치에 push를 진행하게 될경우 다음과 같이 Action이 실행이 되고 dbml에 대해서 자동으로 Build를 해서 생성했던 프로젝트가 업데이트가 지속된다.

 

아래는 내가 CI를 진행했던 과정에 대해서 올렸다. 실패의 경우...처음에 셋팅을 하면서 오탈자나 잘못 셋팅했던게 있어서 실패를 했었다.