हैबर को थोड़ा खंगालने के बाद, मुझे आश्चर्य हुआ कि GitHub के (बीटा) फीचर - एक्शन के विषय पर बहुत कम लेख प्रकाशित हुए हैं।

ऐसा प्रतीत होता है कि इस तरह की अल्पकथन को इस तथ्य से समझाया जा सकता है कि कार्यक्षमता अभी भी परीक्षण में है, यद्यपि "बीटा"। लेकिन यह बीटा की एक उपयोगी विशेषता है जो इस टूल को निजी रिपॉजिटरी में उपयोग करने की अनुमति देती है। इस तकनीक के साथ काम करने के बारे में मैं इस लेख में बात करूंगा।

प्रागितिहास

यदि हम क्रम से शुरू करते हैं, तो संभवतः यह उल्लेख करने योग्य है कि व्यक्तिगत "मेरे बारे में" वेबसाइट को संग्रहीत करने के लिए एक तेज़, सुविधाजनक, आसान और मुफ्त विकल्प की खोज की प्रक्रिया में, मुझे कई रातें बितानी पड़ीं और कई लेखों को खंगालना पड़ा।

कुछ लोग होस्टिंग चुनते हैं, अन्य क्लाउड सर्वर चुनते हैं, और जो लोग इन सबके लिए काम, इंटरैक्शन और भुगतान को समझना नहीं चाहते हैं, वे स्टैटिक साइटों को रिपॉजिटरी में अपलोड करना पसंद करते हैं, क्योंकि अब यह GitHub और GitLab दोनों पर किया जा सकता है।

बेशक, यह हर किसी की निजी पसंद है।

मेरी अंतिम पसंद GitHub Pages थी।

पेजों के बारे में

कौन नहीं जानता gh-pages - यह एक वेबसाइट के रूप में दस्तावेज़ों को संग्रहीत करने का एक विकल्प है और यह निःशुल्क प्रदान किया जाता है, और दस्तावेज़ीकरण के अलावा, व्यक्तिगत वेबसाइटों को भी संग्रहीत करने का प्रस्ताव है। यह कार्यक्षमता GitHub द्वारा सभी उपयोगकर्ताओं को प्रदान की जाती है और रिपॉजिटरी सेटिंग्स में उपलब्ध है।

प्रोजेक्ट रिपॉजिटरी एक शाखा का उपयोग करती है gh-pages, उपयोगकर्ता साइट के लिए - नाम के साथ एक अलग भंडार username.github.io साइट स्रोतों के साथ master शाखा।

आप अधिक विवरण देख सकते हैं दस्तावेज़ीकरण में, लेकिन मैं बस यह नोट कर दूं कि GitHub आश्चर्यजनक रूप से किसी को भी केवल एक फ़ाइल जोड़कर अपने स्वयं के डोमेन को ऐसी साइट से लिंक करने की अनुमति देने में उदार है CNAME डोमेन नाम के साथ और GitHub सर्वर पर अपने डोमेन प्रदाता का DNS सेट करना।

मुझे यकीन है कि ऐसी साइट कैसे विकसित की जाए, इस पर यहां कई लेख हैं, इसलिए यह इसके बारे में आगे नहीं है।

किसी समस्या का घटित होना

समस्या यह थी कि स्थैतिक जनरेटर का उपयोग करते समय, पेज बनाने और उन्हें रिपॉजिटरी में लोड करने की प्रक्रिया को सरल बनाने के लिए अतिरिक्त स्क्रिप्ट लिखने और पुस्तकालयों का उपयोग करने की आवश्यकता होती है। बस, यदि आप स्रोतों को एक अलग निजी भंडार में संग्रहीत करते हैं, तो हर बार जब साइट पर कोई बदलाव होता है, तो मुख्य साइट भंडार में स्थिर पृष्ठों और प्रकाशन की अगली पीढ़ी के लिए स्थानीय वातावरण को तैनात करना आवश्यक था।

बहुतायत है स्थैतिक जनरेटर और उन सभी की समस्या एक जैसी है. इन कार्रवाइयों में बहुत अधिक समय और प्रयास लगता है, और अंततः साइट पर काम धीमा हो जाता है, विशेष रूप से ओएस से ओएस पर कई माइग्रेशन या हार्ड ड्राइव पर डेटा हानि की घटनाओं के बाद (मेरे मामले में यही स्थिति थी).

अभी हाल ही में, या तो वेबसाइट पर एक पॉप-अप अधिसूचना में या गिटहब के न्यूज़लेटर में, एक नवनिर्मित सीआई/सीडी देखी गई, जिसने इन कार्यों को न्यूनतम प्रयास के साथ पूरा करने की अनुमति दी।

स्टेटिक पेज जेनरेटर के बारे में

मैं इस उप-आइटम पर विशेष ध्यान केंद्रित नहीं करूंगा, लेकिन मैं कुछ थीसिस साझा करूंगा जो मुझे निम्नलिखित के चयन और उपयोग के दौरान मिलीं:

1) ऐसा जनरेटर चुनें जो आपकी प्रोग्रामिंग भाषा के अनुकूल हो, या ऐसा जनरेटर चुनें जो जितना संभव हो उतना स्पष्ट हो। मुझे यह विचार उस समय आया जब मुझे स्वयं साइट को काम करने के लिए कुछ कार्यक्षमता जोड़नी पड़ी, इसकी अधिक स्थिरता और स्वचालन के लिए बैसाखी जोड़नी पड़ी। इसके अलावा, प्लगइन्स के रूप में स्वयं अतिरिक्त कार्यक्षमता लिखने का यह एक अच्छा कारण है;

2) कौन सा जनरेटर चुनना है यह एक व्यक्तिगत पसंद है, लेकिन यह विचार करने योग्य है कि GitHub पेज कार्यक्षमता के काम में प्रारंभिक विसर्जन के लिए, आपको पहले इंस्टॉल करना होगा Jekyll. सौभाग्य से, यह आपको सीधे रिपॉजिटरी में स्रोतों से एक वेबसाइट बनाने की अनुमति देता है (मैं इसे अपनी पसंद से दोहराऊंगा).

जेनरेटर की मेरी पसंद पहले बिंदु पर आधारित है। हवासील जो कि पाइथॉन में लिखा गया है, उसने आसानी से जेकिल को बदल दिया, जो मेरे लिए विदेशी है (लगभग एक वर्ष तक इसका उपयोग किया). परिणामस्वरूप, लेख बनाने और संपादित करने तथा किसी वेबसाइट पर काम करने से भी मुझे उस भाषा में अतिरिक्त अनुभव मिलता है जो मेरे लिए दिलचस्प है।

__

समस्या का निरूपण

मुख्य कार्य एक स्क्रिप्ट लिखना होगा (वास्तव में एक कॉन्फ़िगरेशन फ़ाइल) जो स्वचालित रूप से एक निजी भंडार से स्थिर पृष्ठ उत्पन्न करेगी। समाधान में आभासी वातावरण की कार्यक्षमता शामिल होगी। स्क्रिप्ट स्वयं तैयार पृष्ठों को सार्वजनिक भंडार में जोड़ देगी।

समाधान के लिए उपकरण

समस्या को हल करने के लिए हम जिन उपकरणों का उपयोग करेंगे:

• गिटहब क्रियाएँ;
• पायथन 3.7;
• हवासील;
• गिट;
• गिटहब पेज।

समाधान

इसलिए, दस्तावेज़ीकरण से थोड़ा परिचित होने और यह समझने के बाद कि क्रियाओं के लिए स्क्रिप्ट कैसे लिखी जाती हैं, यह स्पष्ट हो गया कि यह तंत्र उत्पन्न हुई समस्या को पूरी तरह से हल कर देगा। लेखन के समय, आपको इस कार्यक्षमता का उपयोग करने के लिए सदस्यता लेनी होगी। बीटा परीक्षण के लिए!

जीथब द्वारा ही नई कार्यक्षमता का विवरण

एक्शन स्क्रिप्ट लिखना एक फ़ोल्डर में नामित फ़ाइल बनाकर शुरू होता है .github और उसका सबफ़ोल्डर workflows. यह या तो मैन्युअल रूप से या रिपॉजिटरी पेज पर एक्शन टैब में संपादक से किया जा सकता है।

रिक्त स्क्रिप्ट प्रपत्र का उदाहरण

मैं फॉर्म पर संक्षेप में टिप्पणी करूंगा

name: CI    # название скрипта: будет отображаться во вкладке Actions

on: [push]  # действие, по которому запускается данный скрипт

jobs:       # роботы, которые будут выполняться
  build:    # сборка, которая..

    runs-on: ubuntu-latest      # ..будет запущена на основе этого образа

    steps:              # шаги которые будут проделаны после запуска образа
    - uses: actions/checkout@v1     # переход в самую актуальную ветку
    - name: Run a one-line script   # имя работы номер 1
      run: echo Hello, world!       # суть работы номер 1 (bash-команда записана в одну строку)
    - name: Run a multi-line script   # имя работы номер 2
      run: |                    # суть работы номер 2 (многострочная)
        echo Add other actions to build,
        echo test, and deploy your project.

आइए टेम्पलेट के आधार पर अपना लिखें:

0) आप "सीआई" नाम भी छोड़ सकते हैं। यह स्वाद का मामला है.

1) इसके बाद, आपको उस एक्शन/ट्रिगर का चयन करना होगा जो स्क्रिप्ट लॉन्च करेगा, हमारे मामले में यह रिपॉजिटरी के लिए एक नई प्रतिबद्धता का सामान्य धक्का है।

on:
  push

2) हम उस छवि को भी छोड़ देंगे जिसके आधार पर स्क्रिप्ट को एक उदाहरण के रूप में लॉन्च किया जाएगा, क्योंकि उबंटू आवश्यक कार्यक्षमता से काफी संतुष्ट है। की ओर देखें उपकरण तैयार करें यह स्पष्ट हो जाता है कि यह कोई भी आवश्यक या बस सुविधाजनक छवि (या उस पर आधारित डॉकर कंटेनर) हो सकती है।

  build:
    runs-on: ubuntu-latest

3) चरणों में, हम पहले मुख्य कार्य की तैयारी के लिए वातावरण स्थापित करेंगे।

3.1) हमें जिस शाखा की आवश्यकता है उस पर जाएं (मानक चरण checkout):

- uses: actions/checkout@v1

3.2) पायथन स्थापित करें:

    - name: Set up Python
      uses: actions/setup-python@v1
      with:
        python-version: 3.7

3.3) हमारे जनरेटर की निर्भरताएँ स्थापित करें:

    - name: Install dependencies
      run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt

3.4) एक निर्देशिका बनाएं जिसमें साइट पेज तैयार किए जाएंगे:

   - name: Make output folder
      run: mkdir output

4) साइट पर काम सुसंगत रहे, अर्थात्, पिछले परिवर्तनों को न हटाएं और बिना किसी विरोध के साइट रिपॉजिटरी में परिवर्तन जोड़ने में सक्षम होने के लिए, अगला कदम हर बार साइट रिपॉजिटरी को क्लोन करना होगा:

   - name: Clone master branch
      run: git clone "https://${{ secrets.ACCESS_TOKEN }}@github.com/${GITHUB_ACTOR}/${GITHUB_ACTOR}.github.io.git" --branch master --single-branch ./output

यह चरण सिस्टम वेरिएबल्स को कॉल करता है:

• चर GITHUB_ACTOR GitHub स्वयं स्थापित होता है, और यह वह उपयोगकर्ता नाम है जिसकी गलती से यह स्क्रिप्ट लॉन्च की गई थी;
• चर secrets.ACCESS_TOKEN यह उत्पन्न होता है Github के प्रबंधन के लिए टोकन, हम इसे टैब में सेट करके एक पर्यावरण चर के रूप में पारित कर सकते हैं Secrets हमारी रिपॉजिटरी सेटिंग्स। कृपया ध्यान दें कि पीढ़ी के दौरान हमें टोकन एक बार प्रदान किया जाएगा, इसके बाद उस तक कोई पहुंच नहीं होगी। साथ ही रहस्य वस्तुओं के मूल्य भी।

5) आइए अपने पेज बनाने की ओर आगे बढ़ें:

   - name: Generate static pages
      run: pelican content -o output -s publishconf.py

जनरेटर को दिए गए पैरामीटर उस निर्देशिका के लिए ज़िम्मेदार हैं जहां जेनरेट की गई फ़ाइलें भेजी जाएंगी (-o output) और कॉन्फ़िगरेशन फ़ाइल जिसका उपयोग हम उत्पन्न करने के लिए करते हैं (-s publishconf.py; आप पेलिकन दस्तावेज़ में प्रकाशन के लिए स्थानीय कॉन्फ़िगरेशन और कॉन्फ़िगरेशन को अलग करने के दृष्टिकोण के बारे में पढ़ सकते हैं).

मैं आपको याद दिला दूं कि हमारे फ़ोल्डर में क्या है output साइट रिपॉजिटरी पहले ही क्लोन की जा चुकी है।

6) आइए git सेट करें और अपनी बदली हुई फ़ाइलों को अनुक्रमित करें:

    - name: Set git config and add changes
      run: |
          git config --global user.email "${GITHUB_ACTOR}@https://users.noreply.github.com/"
          git config --global user.name "${GITHUB_ACTOR}"
          git add --all
      working-directory: ./output

इस बिंदु पर, पहले से ही ज्ञात चर का उपयोग किया जाता है और कार्यशील निर्देशिका को इंगित किया जाता है जिसमें इस चरण से कमांड लॉन्च किए जाएंगे। कार्यशील निर्देशिका में जाने का आदेश अन्यथा ऐसा दिखेगा - cd output.

7) आइए एक प्रतिबद्ध संदेश बनाएं, परिवर्तन करें और उन्हें रिपॉजिटरी में धकेलें। ताकि प्रतिबद्धता व्यर्थ न हो और इसलिए बैश में कोई त्रुटि उत्पन्न न हो (आउटपुट परिणाम नहीं है)। 0) - सबसे पहले, आइए जाँच करें कि क्या कुछ प्रतिबद्ध करना और आगे बढ़ाना आवश्यक है। ऐसा करने के लिए हम कमांड का उपयोग करते हैं git diff-index --quiet --cached HEAD -- जो टर्मिनल पर आउटपुट करेगा 0 यदि साइट के पिछले संस्करण के सापेक्ष कोई परिवर्तन नहीं हैं, और 1 ऐसे बदलाव हैं. फिर हम इस कमांड के परिणाम को संसाधित करते हैं। इस प्रकार, स्क्रिप्ट के निष्पादन के बारे में जानकारी में, हम स्वचालित रूप से क्रैश होने और हमें स्क्रिप्ट क्रैश के बारे में एक रिपोर्ट भेजने के बजाय, इस चरण में साइट की स्थिति के बारे में उपयोगी जानकारी रिकॉर्ड करेंगे।

हम इन कार्यों को अपनी निर्देशिका में तैयार पृष्ठों के साथ भी करते हैं।

   - name: Push and send notification
      run: |
          COMMIT_MESSAGE="Update pages on $(date +'%Y-%m-%d %H:%M:%S')"
          git diff-index --quiet --cached HEAD -- && echo "No changes!" && exit 0 || echo $COMMIT_MESSAGE
          # Only if repo have changes
          git commit -m "${COMMIT_MESSAGE}"
          git push https://${{ secrets.ACCESS_TOKEN }}@github.com/${GITHUB_ACTOR}/${GITHUB_ACTOR}.github.io.git master
      working-directory: ./output

परिणाम

परिणामस्वरूप, ऐसी स्क्रिप्ट आपको स्थिर पेज बनाने के बारे में सोचने की अनुमति नहीं देती है। किसी निजी रिपॉजिटरी में सीधे परिवर्तन जोड़कर, चाहे किसी सिस्टम के तहत गिट के साथ काम करके या गिटहब वेब इंटरफ़ेस के माध्यम से फ़ाइल बनाकर, क्रियाएँ स्वयं सब कुछ करेंगी। यदि स्क्रिप्ट अप्रत्याशित रूप से क्रैश हो जाती है, तो आपके ईमेल पर एक अधिसूचना भेजी जाएगी।

पूरा कोड

मैं अपना कार्यशील संस्करण छोड़ दूँगा, जिसमें अंतिम चरण में एक अधिसूचना भेजना शामिल है कि एक प्रतिबद्धता को मुख्य भंडार में धकेल दिया गया है।

ऊपर वर्णित रहस्यों का उपयोग किया जाता है, जहां बॉट टोकन और उपयोगकर्ता आईडी जिसे संदेश भेजा जाना है, जोड़ा जाता है।

name: Push content to the user's GitHub pages repository

on:
  push

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v1
    - name: Set up Python
      uses: actions/setup-python@v1
      with:
        python-version: 3.7
    - name: Install dependencies
      run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
    - name: Make output folder
      run: mkdir output
    - name: Clone master branch
      run: git clone "https://${{ secrets.ACCESS_TOKEN }}@github.com/${GITHUB_ACTOR}/${GITHUB_ACTOR}.github.io.git" --branch master --single-branch ./output
    - name: Generate static pages
      run: pelican content -o output -s publishconf.py
    - name: Set git config and add changes
      run: |
          git config --global user.email "${GITHUB_ACTOR}@https://users.noreply.github.com/"
          git config --global user.name "${GITHUB_ACTOR}"
          git add --all
      working-directory: ./output
    - name: Push and send notification
      run: |
          COMMIT_MESSAGE="Update pages on $(date +'%Y-%m-%d %H:%M:%S')"
          git diff-index --quiet --cached HEAD -- && echo "No changes!" && exit 0 || echo $COMMIT_MESSAGE
          git commit -m "${COMMIT_MESSAGE}"
          git push https://${{ secrets.ACCESS_TOKEN }}@github.com/${GITHUB_ACTOR}/${GITHUB_ACTOR}.github.io.git master
          curl "https://api.telegram.org/bot${{ secrets.BOT_TOKEN }}/sendMessage?text=$COMMIT_MESSAGE %0ALook at ${GITHUB_ACTOR}.github.io %0ARepository%3A github.com/${GITHUB_ACTOR}/${GITHUB_ACTOR}.github.io&chat_id=${{ secrets.ADMIN_ID }}"
      working-directory: ./output

स्क्रीनशॉट

किसी एक रन का परिणाम स्रोत रिपॉजिटरी के एक्शन टैब में प्रदर्शित होता है

स्क्रिप्ट के पूरा होने के बारे में बॉट से संदेश

उपयोगी लिंक्स

क्रियाओं को समझना
क्रिया वाक्यविन्यास
ट्रिगर्स की सूची
आभासी वातावरण के लिए विकल्प
जीथब पेज
स्थैतिक जेनरेटर सूची

स्रोत: www.habr.com