mainbot github action
1.0.0
GitHub Action นี้ช่วยให้คุณสามารถอัปโหลดไฟล์จากพื้นที่เก็บข้อมูลของคุณไปยังตำแหน่งข้อมูล mainbot API ได้โดยอัตโนมัติ
glob-pattern จำเป็น รูปแบบ glob ที่ใช้เพื่อค้นหาไฟล์ในพื้นที่เก็บข้อมูล ค่าเริ่มต้น: ./docs/**
namespaceจำเป็น เนมสเปซของจุดสิ้นสุด mainbot API
api-urlจำเป็นต้อง มีจุดสิ้นสุด Mainbot API ที่จะอัปโหลดไฟล์
client-idตัวเลือก ID ไคลเอ็นต์สำหรับการตรวจสอบสิทธิ์ OAuth หาก API ของคุณกำหนด
client-secretตัวเลือกเสริม ข้อมูลลับไคลเอ็นต์สำหรับการตรวจสอบสิทธิ์ OAuth หาก API ของคุณต้องการ
token-endpointตัวเลือก ปลายทางโทเค็นสำหรับการตรวจสอบสิทธิ์ OAuth หาก API ของคุณต้องการ
client_id และ client_secret ) หาก API เป้าหมายต้องมีการตรวจสอบสิทธิ์ OAuth เพิ่ม GitHub Action ไปยังพื้นที่เก็บข้อมูลของคุณ
สร้างไดเร็กทอรี .github/workflows ในรูทของที่เก็บของคุณ (หากยังไม่มี) และเพิ่มไฟล์ YAML ใหม่สำหรับเวิร์กโฟลว์ของคุณ (เช่น upload-files.yml )
กำหนดค่าไฟล์เวิร์กโฟลว์
ตั้งค่าไฟล์เวิร์กโฟลว์ของคุณด้วยขั้นตอนที่จำเป็น ด้านล่างนี้เป็นตัวอย่างการกำหนดค่า:
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ตั้งค่าความลับ GitHub
ไปที่การตั้งค่า > ความลับของพื้นที่เก็บข้อมูลของคุณ และเพิ่ม CLIENT_ID และ CLIENT_SECRET ของคุณ
เมื่อติดตั้งแล้ว การดำเนินการจะทำงานโดยอัตโนมัติตามทริกเกอร์ที่กำหนดไว้ในไฟล์เวิร์กโฟลว์ของคุณ (เช่น ทุกครั้งที่พุชไปยังสาขา main ) การดำเนินการจะ:
สำหรับการสนับสนุน ปัญหา หรือการร้องขอคุณสมบัติ โปรดยื่นปัญหาในพื้นที่เก็บข้อมูล GitHub
