RSS 피드를 사용하여 Github 프론트 페이지 자동 업데이트

https://github.com/SukbeomH/GH-FrontPageUpdater

GitHub - SukbeomH/GH-FrontPageUpdater: 🎥 Github front page updater that work with RSS feed!

 

RSS 피드를 사용하여 Github 프론트 페이지 자동 업데이트하기!

1. RSS 피드를 통해 최신 블로그 게시물을 Github 저장소의 프론트 페이지에 업데이트하는 간단한 프로젝트를 만들었습니다.

 

2. 자신의 블로그, 혹은 원하는 최신 블로그 게시물 또는 원하는 RSS 피드를 사용하여 README.md 파일을 자동으로 업데이트합니다.

• 이 스크립트를 사용하면, 웹사이트의 최신 블로그 게시물을 Github 저장소에 자동으로 반영할 수 있습니다.
• 또는 원하는 RSS 피드를 사용할 수 있습니다.

 

3. GitHub Action 스크립트를 통해 자동화 설정이 되어있습니다.

• 스크립트는 README.md 파일을 자동으로 업데이트하고, 변경 사항을 저장소에 푸시합니다.
• 물론 수동으로 스크립트를 실행할 수도 있습니다 :)

글만 쓰면 자동으로 잔디를 채워준다고 아 ㅋㅋㅋ

 

시작하기

로컬 개발을 위한 사전 준비 사항

• 로컬에 node.js가 설치되어 있어야 합니다.
• NPM도!

설치 방법

1. 저장소를 git clone 합니다.
2. npm install 명령어로 필요한 종속성을 설치합니다.
3. npm start 명령어로 스크립트를 테스트하거나 개발할 수 있습니다.

사용 방법

이 스크립트는 매일 UTC 02:00에 Github Actions를 통해 자동으로 실행됩니다.

수동으로 Github Actions에서 스크립트를 실행할 수도 있습니다.

설정

GitHub Actions 설정

1. 이 저장소를 포크합니다.
2. 저장소의 Settings 탭으로 이동합니다.
3. 왼쪽 사이드바에서 Actions 섹션으로 이동합니다.
4. General 탭을 클릭합니다.
5. 워크플로우가 실행되도록 Workflow permissions 기능을 활성화합니다.
6. 저장소에 변경 사항을 푸시하려면 Read and write 권한이 필요합니다.
7. Allow GitHub Actions to create and approve pull requests 항목을 체크합니다.

./config.json 파일 설정

이 파일은 스크립트의 설정을 담고 있습니다. 필요에 따라 설정을 변경할 수 있습니다.

{
    "rssFeed": "https://veritasgarage.tistory.com/rss",
    "maxPosts": 5
}

./markdown/staticHeader.md 파일 설정

이 파일은 생성되는 마크다운 파일의 시작 부분에 추가될 헤더를 포함합니다. 원하는 마크다운 내용을 추가하여 파일의 시작 부분을 구성할 수 있습니다.

필요없다면, 파일의 내용을 모두 삭제하면 됩니다.

./markdown/staticFooter.md 파일 설정

이 파일은 생성되는 마크다운 파일의 끝 부분에 추가될 푸터를 포함합니다. 원하는 마크다운 내용을 추가하여 파일의 끝 부분을 구성할 수 있습니다.

빈 파일로 시작하려면, 파일의 내용을 모두 삭제하면 됩니다.

 

---

당연하게도, 깃허브 프로필로 사용하고 싶다면 깃허브아이디 이름으로 된 레포지토리를 이 레포를 포크해서 사용하시면 됩니다.

 

친환경 코딩으로 이루어진 탄소중립코드입니다.