공부한 내용을 가볍게 후다닥 적을 수 있으면서도 공개적이며 누군가 나의 성장 과정을 빠르게 확인할 수 있는 공간의 필요성을 요즘 느끼고 있다. 검색하는 중 TIL(Today I Learn) 작성에 대해 알게 되었고, 이것이 내가 찾던 공부와 블로그 사이 징검다리가 될 수 있을 것 같았다. (이전에 내가 정보를 검색하면서 보았던 github의 글들이 사실은 TIL였다는 것도 알게 됨)

TIL를 작성할 공간은 github로 정했다. github에 더욱 익숙해지고 싶기도 하고, 기록 tracker의 역할도 할 수 있는 잔디밭의 존재와 새로운 플랫폼에서 글을 작성하는 것도 기록하는 습관에 활력을 더해줄 것이란 기대 때문이다.

TIL

repo 생성

간단하게 repo만 생성해서 TIL를 작성하기로 정했다.

새로운 repository를 만들 때, README.md도 함께 만들어주고,
훗날 내가 작성한 글이 남용되지 않게 하기위해, License를 MIT License로 설정했다.

Github Action으로 README.md 자동 작성

새로운 TIL을 작성할 때마다 README를 새로 작성하는건 귀찮은 일이기 때문에, 이 곳에서 제공하는 build.yml 파일과 Github Action을 사용하여 자동화했다.

Actions로 가서 내 workflow를 만든다. set up workflow yourself를 클릭하거나 simple workflow의 configure버튼을 눌러도 된다. 어떤 방법으로든 workflow를 만들어도, build.yml의 경로는 아래와 같아야한다.

.github/workflows/build.yml

나는 이 곳 에서 제공하는 build.yml양식을 아래와같이 조금 변경했다. main branch를 사용하기 때문에 branches를 master -> main으로 변경했고, description도 변경했다.

name: Build README
on:
  push:
    branches:
      - main
    paths-ignore:
      - README.md
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repo
        uses: actions/checkout@v2
        with:
          # necessary for github-action-til-autoformat-readme
          fetch-depth: 0
      - name: Autoformat README
        uses: cflynn07/github-action-til-autoformat-readme@1.2.0
        with:
          description: |
            오늘 공부한 내용을 작성하는 공간입니다. 공부를 하고 이곳에 TIL를 적은 다음, 정제한 내용을 블로그에 작성합니다.
          footer: |
            [1]: https://simonwillison.net/2020/Apr/20/self-rewriting-readme/
            [2]: https://github.com/jbranchaud/til
          list_most_recent: 5 # optional, lists most recent TILS below description
          date_format: '2020 Jan 15:04' # optional, must align to https://golang.org/pkg/time/#Time.Format

빌드 이슈 처리

이렇게 작성해서 push를 했는데, 정상적으로 빌드되지 않았다.

(#3인 이유는 workflow의 경로를 잘못 적어서..)

클릭하여 error msg를 찾아보니, 접근이 제한되어서 빌드에 실패했다고 나온다. 바로 검색을 했고, 깃허브에서 생성된 이슈에서 문제의 원인을 찾을 수 있었다. workflow를 작성할 권한이 없는데 작성을 한 것이 문제였다.

repo의 settings > Actions > general에서 workflow permission이 read and write permissions에 체크해주고 save를 하면

정상적으로 빌드된 것을 확인할 수 있다. 이후 repo내에 Spring 폴더를 생성하고 test.md 파일을 작성하여 push했더니,

정상적으로 작성되는 것을 확인할 수 있었다.

추가사항

• TIL를 작성할 때 H1(#)가 인덱싱되어 README.md에 제목으로 사용되니 H1을 꼭 작성해야한다.
• md 파일 명은 space 없이 작성해야한다. 아니면 README.md에 글 링크가 제대로 생성되지 않는다.
  
  파일 이름에 space가 있을 때, '트랜잭션'으로 링크가 생성되야하지만, 카테고리와 md 파일 이름이 뒤에 붙은 text로 작성되었다. space가 없으면 정상적으로 링크가 생성된다.
• md 파일의 제목(#)을 수정하면 README에서는 새 글로 간주되어 위 사진에 표시되는 시간이 리셋된다