mainbot github action

메인봇-github-액션

이 GitHub 작업을 사용하면 리포지토리에서 메인봇 API 엔드포인트로 파일을 자동으로 업로드할 수 있습니다.

입력

glob-pattern

필수 저장소에서 파일을 찾는 데 사용되는 glob 패턴입니다. 기본값: ./docs/** .

namespace

필수 메인봇 API 엔드포인트의 네임스페이스입니다.

api-url

필수 파일이 업로드될 Mainbot API 엔드포인트입니다 .

client-id

선택 사항 API에서 요구하는 경우 OAuth 인증을 위한 클라이언트 ID입니다.

client-secret

선택사항 API에서 요구하는 경우 OAuth 인증을 위한 클라이언트 비밀번호입니다.

token-endpoint

선택 사항 API에 필요한 경우 OAuth 인증을 위한 토큰 끝점입니다.

특징

• 파일 선택을 위한 Glob 패턴 일치.
• 상대 파일 경로, 저장소, 소유자를 포함한 메타데이터가 포함된 파일을 업로드하세요.
• OAuth 토큰 인증 지원.

전제 조건

• 이 작업을 구현할 수 있는 GitHub 저장소입니다.
• 대상 API에 OAuth 인증이 필요한 경우 필요한 자격 증명(예: client_id 및 client_secret )입니다.

설치

1. 저장소에 GitHub 작업 추가

   저장소 루트에 .github/workflows 디렉터리를 만들고(아직 없는 경우) 워크플로에 대한 새 YAML 파일을 추가합니다(예: upload-files.yml ).

2. 워크플로 파일 구성

   필요한 단계에 따라 워크플로 파일을 설정합니다. 다음은 구성 예입니다.

    name : Upload Files to API
   
   on :
     workflow_dispatch : {} # Enable manual triggering
     push :
       branches :
         - main  # Set your branch here
       paths :
         - ' docs/** '  # Set your docs folder path here
   
   jobs :
     upload :
       runs-on : ubuntu-latest
       steps :
         - name : Checkout repository
           uses : actions/checkout@v2
         
         - name : Upload Files
           uses : savantly-net/mainbot-github-action@main
           with :
             glob-patterns : ' **/*.txt '  # Set your file pattern here
             namespace : ' /admin '
             api-url : ' https://mainbot.savantly.net ' # Set your Mainbot API endpoint here
             client-id : ${{ secrets.CLIENT_ID }} # Set your client ID here
             client-secret : ${{ secrets.CLIENT_SECRET }} # Set your client secret here
             token-endpoint : ' https://mainbot.savantly.net/oauth/token ' # Set your token endpoint here

3. GitHub 비밀 설정

   저장소의 설정 > 비밀로 이동하여 CLIENT_ID 및 CLIENT_SECRET 추가하세요.

용법

일단 설치되면 작업은 워크플로 파일에 정의된 트리거에 따라 자동으로 실행됩니다(예: main 분기로 푸시될 때마다). 작업은 다음과 같습니다.

1. 정의된 glob 패턴과 일치하는 저장소에서 파일을 검색합니다.
2. 발견된 각 파일에 대해 메타데이터의 파일 콘텐츠 및 상대 경로와 함께 지정된 API 엔드포인트에 업로드합니다.

지원하다

지원, 문제 또는 기능 요청이 있는 경우 GitHub 저장소에 문제를 제출하세요.