हॅब्रला थोडेसे चाळल्यानंतर, मला आश्चर्य वाटले की GitHub च्या (बीटा) वैशिष्ट्य - क्रिया या विषयावर फार कमी लेख प्रकाशित केले गेले आहेत.

असे दिसते की अशा अधोरेखितपणाचे स्पष्टीकरण या वस्तुस्थितीद्वारे केले जाऊ शकते की कार्यक्षमता अद्याप चाचणीमध्ये आहे, जरी “बीटा”. परंतु हे बीटाचे एक उपयुक्त वैशिष्ट्य आहे जे हे साधन खाजगी भांडारांमध्ये वापरण्याची परवानगी देते. या तंत्रज्ञानासह काम करण्याबद्दल मी या लेखात बोलणार आहे.

प्रागैतिहासिक

जर आपण क्रमाने सुरुवात केली, तर हे लक्षात घेण्यासारखे आहे की वैयक्तिक “माझ्याबद्दल” वेबसाइट संग्रहित करण्यासाठी वेगवान, सोयीस्कर, सुलभ आणि विनामूल्य पर्याय शोधण्याच्या प्रक्रियेत, मला अनेक रात्री घालवाव्या लागल्या आणि अनेक लेखांमधून कंघी करावी लागली.

काही लोक होस्टिंग निवडतात, इतर क्लाउड सर्व्हर आणि ज्यांना या सर्वांसाठी काम, परस्परसंवाद आणि पेमेंट समजून घ्यायचे नाही जसे की रेपॉजिटरीमध्ये स्थिर साइट अपलोड करणे, आता हे GitHub आणि GitLab दोन्हीवर केले जाऊ शकते.

अर्थात ही प्रत्येकाची वैयक्तिक निवड आहे.

माझी अंतिम निवड GitHub पृष्ठे होती.

पृष्ठांबद्दल

कोणाला माहीत नाही gh-pages - वेबसाइटच्या स्वरूपात दस्तऐवज संग्रहित करण्याचा हा एक पर्याय आहे आणि तो विनामूल्य प्रदान केला जातो आणि दस्तऐवजीकरणाव्यतिरिक्त, वैयक्तिक वेबसाइट देखील संग्रहित करण्याचा प्रस्ताव आहे. ही कार्यक्षमता GitHub द्वारे सर्व वापरकर्त्यांना प्रदान केली जाते आणि रेपॉजिटरी सेटिंग्जमध्ये उपलब्ध आहे.

प्रकल्प भांडार शाखा वापरते gh-pages, वापरकर्ता साइटसाठी - नावासह एक स्वतंत्र भांडार username.github.io मध्ये साइट स्त्रोतांसह master शाखा

तुम्ही अधिक तपशील पाहू शकता दस्तऐवजीकरण मध्ये, परंतु मी फक्त हे लक्षात ठेवतो की GitHub कोणालाही फक्त फाइल जोडून त्यांच्या स्वतःच्या डोमेनला अशा साइटशी लिंक करण्याची परवानगी देण्यात आश्चर्यकारकपणे उदार आहे CNAME डोमेन नावासह आणि GitHub सर्व्हरवर तुमच्या डोमेन प्रदात्याचा DNS सेट करा.

मला खात्री आहे की अशी साइट कशी विकसित करावी याबद्दल येथे बरेच लेख आहेत, म्हणून मी पुढे बोलणार नाही.

समस्या उद्भवतात

अडचण अशी होती की स्टॅटिक जनरेटर वापरताना, अतिरिक्त स्क्रिप्ट लिहिण्याची आणि लायब्ररी वापरण्याची आवश्यकता असते ज्यामुळे पृष्ठे निर्माण करण्याची आणि त्यांना रेपॉजिटरीमध्ये लोड करण्याची प्रक्रिया सुलभ होते. फक्त, जर तुम्ही स्त्रोत वेगळ्या खाजगी भांडारात संग्रहित केले, तर प्रत्येक वेळी साइटवर कोणताही बदल झाल्यास, स्थिर पृष्ठांच्या पुढील पिढीसाठी आणि मुख्य साइट रिपॉजिटरीमध्ये प्रकाशनासाठी स्थानिक वातावरण तैनात करणे आवश्यक होते.

विपुलता आहे स्थिर जनरेटर आणि त्यांना सर्व समान समस्या आहेत. या क्रियांना खूप वेळ आणि मेहनत लागते आणि शेवटी साइटवरील काम मंदावते, विशेषत: OS वरून OS वर अनेक स्थलांतरानंतर किंवा हार्ड ड्राइव्हवरील डेटा गमावण्याच्या घटनांनंतर (माझ्या बाबतीत असेच होते).

नुकतेच, वेबसाइटवरील पॉप-अप नोटिफिकेशनमध्ये किंवा GitHub कडील वृत्तपत्रात, एक नवीन तयार केलेले CI/CD लक्षात आले, ज्यामुळे या क्रिया कमीत कमी प्रयत्नात करणे शक्य झाले.

स्थिर पृष्ठ जनरेटर बद्दल

मी या उप-आयटमवर विशेष लक्ष केंद्रित करणार नाही, परंतु मी खालीलपैकी निवड आणि वापरादरम्यान आलेल्या काही प्रबंध सामायिक करेन:

1) तुमच्या प्रोग्रामिंग भाषेला अनुकूल असा जनरेटर निवडा किंवा शक्य तितक्या स्पष्ट असेल. मला ही कल्पना अशा वेळी सुचली जेव्हा मला स्वतःला साइटवर कार्य करण्यासाठी काही कार्यक्षमता जोडायची होती, त्याच्या अधिक स्थिरतेसाठी आणि ऑटोमेशनसाठी क्रॅच जोडावे लागले. याव्यतिरिक्त, प्लगइनच्या स्वरूपात अतिरिक्त कार्यक्षमता स्वतः लिहिण्याचे हे एक चांगले कारण आहे;

2) कोणता जनरेटर निवडायचा ही वैयक्तिक निवड आहे, परंतु हे लक्षात घेण्यासारखे आहे की GitHub पृष्ठांच्या कार्यक्षमतेच्या कामात प्रारंभिक विसर्जनासाठी, आपण प्रथम स्थापित करणे आवश्यक आहे. जेकिल. सुदैवाने, ते तुम्हाला थेट रेपॉजिटरीमधील स्त्रोतांकडून वेबसाइट तयार करण्याची परवानगी देते (मी माझ्या आवडीने याची पुनरावृत्ती करेन).

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

__

समस्येची निर्मिती

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

समाधानासाठी साधने

आम्ही समस्येचे निराकरण करण्यासाठी वापरलेली साधने:

• GitHub क्रिया;
• पायथन 3.7;
• पेलिकन;
• गिट;
• GitHub पृष्ठे.

समस्या सोडवणे

म्हणून, दस्तऐवजीकरणाची थोडीशी ओळख करून घेतल्यानंतर आणि क्रियांसाठी स्क्रिप्ट्स कशा लिहिल्या जातात हे समजून घेतल्यावर, हे स्पष्ट झाले की ही यंत्रणा उद्भवलेल्या समस्येचे पूर्णपणे निराकरण करेल. लेखनाच्या वेळी, आपण ही कार्यक्षमता वापरण्यासाठी सदस्यता घेणे आवश्यक आहे. बीटा चाचणीसाठी!

Github द्वारेच नवीन कार्यक्षमतेचे वर्णन

फोल्डरमध्ये नावाची फाइल तयार करून क्रिया स्क्रिप्ट लिहिणे सुरू होते .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) तुम्ही "CI" नाव देखील सोडू शकता. चवीची बाब आहे.

1) पुढे, तुम्हाला स्क्रिप्ट लाँच करणारी क्रिया/ट्रिगर निवडण्याची आवश्यकता आहे, आमच्या बाबतीत हे रिपॉझिटरीमध्ये नवीन कमिट करण्याचा नेहमीचा धक्का आहे.

on:
  push

२) उबंटू आवश्यक कार्यक्षमतेसह समाधानी असल्याने आम्ही प्रतिमा देखील सोडू ज्या आधारावर स्क्रिप्ट लाँच केली जाईल. च्या कडे बघणे उपलब्ध साधने हे स्पष्ट होते की ही कोणतीही आवश्यक किंवा फक्त सोयीस्कर प्रतिमा (किंवा त्यावर आधारित डॉकर कंटेनर) असू शकते.

  build:
    runs-on: ubuntu-latest

3) चरणांमध्ये, आम्ही मुख्य कामाच्या तयारीसाठी प्रथम वातावरण तयार करू.

३.१) आम्हाला आवश्यक असलेल्या शाखेत जा (मानक पायरी 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.

७) कमिट मेसेज व्युत्पन्न करू, बदल करू आणि त्यांना रिपॉजिटरीमध्ये ढकलू. जेणेकरून कमिट व्यर्थ ठरत नाही आणि त्यामुळे बॅशमध्ये त्रुटी निर्माण होत नाही (आउटपुट परिणाम नाही 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

परिणाम

परिणामी, अशी स्क्रिप्ट आपल्याला स्थिर पृष्ठे तयार करण्याबद्दल विचार न करण्याची परवानगी देते. खाजगी रिपॉजिटरीमध्ये थेट बदल जोडून, ​​कोणत्याही सिस्टमच्या अंतर्गत git सह कार्य करून किंवा GitHub वेब इंटरफेसद्वारे फाइल तयार करून, क्रिया स्वतःच सर्वकाही करेल. स्क्रिप्ट अनपेक्षितपणे क्रॅश झाल्यास, तुमच्या ईमेलवर सूचना पाठवली जाईल.

पूर्ण कोड

मी माझी कार्यरत आवृत्ती सोडेन, ज्यामध्ये शेवटची पायरी मुख्य रेपॉजिटरीमध्ये कमिट ढकलली गेल्याची सूचना पाठवते.

वर वर्णन केलेली रहस्ये वापरली जातात, जिथे बॉट टोकन आणि ज्याला संदेश पाठवायचा आहे तो वापरकर्ता आयडी जोडला जातो.

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

स्क्रिनशॉट्स

स्त्रोत भांडाराच्या क्रिया टॅबमध्ये प्रदर्शित केलेल्या धावांपैकी एकाचा परिणाम

स्क्रिप्ट पूर्ण झाल्याबद्दल बॉटकडून मेसेज

उपयुक्त दुवे

कृती समजून घेणे
क्रिया वाक्यरचना
ट्रिगर्सची यादी
आभासी वातावरणासाठी पर्याय
Github पृष्ठे
स्थिर जनरेटर यादी

स्त्रोत: www.habr.com