हैबर इस बात से थोड़ा हैरान था कि गीथहब के फीचर्स - एक्ट्स के विषय पर बहुत कम लेख प्रकाशित हुए हैं।

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

प्रागितिहास

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

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

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

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

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

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

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

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

मुझे यकीन है कि इस तरह की साइट को तैनात करने के बारे में कई लेख हैं, इसलिए यह इस बारे में नहीं है।

किसी समस्या का होना

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

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

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

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

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

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

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

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

समस्या का बयान

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

समाधान उपकरण

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

गिटहब क्रिया;
अजगर 3.7
हवासील;
git;
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

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

३.४) एक निर्देशिका बनाएं जिसमें साइट पृष्ठ उत्पन्न होंगे:

  - 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}.imtqy.com.git" --branch master --single-branch ./output

यह चरण सिस्टम चर कहता है:

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

5) हम अपने पृष्ठों की पीढ़ी के लिए आगे बढ़ते हैं:

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

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

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

6) हमारे संशोधित फ़ाइलों को कॉन्फ़िगर और अनुक्रमित करें:

  - 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}.imtqy.com.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}.imtqy.com.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}.imtqy.com.git master curl "https://api.telegram.org/bot${{ secrets.BOT_TOKEN }}/sendMessage?text=$COMMIT_MESSAGE %0ALook at ${GITHUB_ACTOR}.imtqy.com %0ARepository%3A github.com/${GITHUB_ACTOR}/${GITHUB_ACTOR}.imtqy.com&chat_id=${{ secrets.ADMIN_ID }}" working-directory: ./output

स्क्रीनशॉट

सूत्रों के साथ रिपॉजिटरी के कार्य टैब में प्रदर्शित लॉन्च में से एक का परिणाम

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

उपयोगी लिंक

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

GitHub एक स्थिर जनरेटर और GitHub पेज पर साइट के लिए CI / CD के रूप में कार्य करता है