לאחר שחיפשתי את Habr מעט, הופתעתי שמעט מאוד מאמרים פורסמו בנושא התכונה של GitHub (בטא) - פעולות.

נראה שניתן להסביר אנדרסטייטמנט כזה בעובדה שהפונקציונליות עדיין בבדיקה, אם כי "בטא". אבל זו תכונה שימושית של הבטא שמאפשרת להשתמש בכלי זה במאגרים פרטיים. זה על עבודה עם הטכנולוגיה הזו שעליה אדבר במאמר זה.

פרהיסטוריה

אם נתחיל לפי הסדר, אז מן הסתם ראוי להזכיר שבתהליך חיפוש אחר אפשרות מהירה, נוחה, קלה וחינמית לאחסון אתר אישי "אודותי", נאלצתי לבלות מספר לילות ולסרוק מאמרים רבים.

יש אנשים שבוחרים באחסון, אחרים בשרת ענן, ומי שלא רוצה להבין את העבודה, האינטראקציה והתשלום על כל זה כמו העלאת אתרים סטטיים למאגר, שכן כעת ניתן לעשות זאת גם ב-GitHub וגם ב-GitLab.

כמובן שזו בחירה אישית של כל אחד.

הבחירה הסופית שלי הייתה GitHub Pages.

על דפים

מי לא מודע gh-pages - זוהי אפשרות לאחסון תיעוד בצורת אתר אינטרנט והיא ניתנת ללא תשלום, ובנוסף לתיעוד, מוצע גם לאחסן אתרים אישיים. פונקציונליות זו מסופקת על ידי GitHub לכל המשתמשים וזמינה בהגדרות המאגר.

מאגר הפרויקטים משתמש בענף gh-pages, עבור אתר משתמש - מאגר נפרד עם השם username.github.io עם מקורות האתר ב master ענף.

תוכל לראות פרטים נוספים בתיעוד, אבל הרשו לי רק לציין ש-GitHub הוא נדיב באופן מפתיע בכך שהוא מאפשר לכל אחד לקשר את הדומיין שלו לאתר כזה פשוט על ידי הוספת קובץ CNAME עם שם הדומיין והגדרת ה-DNS של ספק הדומיין שלך בשרתי GitHub.

אני בטוח שיש כאן הרבה מאמרים על איך לפתח אתר כזה, אז לא על זה אני הולך לדבר יותר.

מתעוררת בעיה

הבעיה הייתה שכאשר משתמשים במחולל סטטי, יש צורך לכתוב סקריפטים נוספים ולהשתמש בספריות כדי לפשט את תהליך יצירת הדפים וטעינתם למאגר. פשוט, אם אתה מאחסן את המקורות במאגר פרטי נפרד, אז בכל פעם שיש שינוי כלשהו באתר, היה צורך לפרוס את הסביבה המקומית עבור הדור הבא של דפים סטטיים ופרסום במאגר האתר הראשי.

יש שפע גנרטורים סטטיים ולכולם יש את אותה בעיה. פעולות אלו לוקחות יותר מדי זמן ומאמץ, ובסופו של דבר מאטות את העבודה באתר, במיוחד לאחר מספר העברות ממערכת הפעלה למערכת הפעלה או תקריות עם אובדן נתונים בכוננים קשיחים (זה היה המקרה במקרה שלי).

רק לאחרונה, או בהתראה מוקפצת באתר או בניוזלטר מבית GitHub, הבחינו ב-CI/CD חדש שנבנה, שאיפשר לבצע את הפעולות הללו במינימום מאמץ.

על מחוללי דפים סטטיים

לא אתמקד תשומת לב מיוחדת בפריט המשנה הזה, אבל אשתף כמה תזות שהגעתי אליהן במהלך הבחירה והשימוש בפריטים הבאים:

1) בחר גנרטור שמתאים לשפת התכנות שלך, או כזה ברור ככל האפשר. הגעתי לרעיון הזה בתקופה שבה אני עצמי הייתי צריך להוסיף קצת פונקציונליות כדי שהאתר יעבוד, להוסיף קביים ליציבות ואוטומציה יותר. בנוסף, זו סיבה טובה לכתוב פונקציונליות נוספת בעצמך בצורה של תוספים;

2) איזה גנרטור לבחור היא בחירה אישית, אבל כדאי לקחת בחשבון שלצורך ההתעמקות הראשונית בעבודה של הפונקציונליות של GitHub Pages, תחילה עליך להתקין ג'קיל. למרבה המזל, זה מאפשר לך ליצור אתר אינטרנט ממקורות ישירות במאגר (אני אחזור על זה עם הבחירה שלי).

הבחירה שלי בגנרטור מבוססת על הנקודה הראשונה. שַׁקנַאי שנכתב בפייתון החליף בקלות את ג'קיל, שזר לי (השתמש בו כמעט שנה). כתוצאה מכך, גם יצירה ועריכה של מאמרים ועבודה באתר נותנים ניסיון נוסף בשפה שמעניינת אותי.

__

הצהרת הבעיה

המשימה העיקרית תהיה לכתוב סקריפט (למעשה קובץ תצורה) שייצור אוטומטית דפים סטטיים ממאגר פרטי. הפתרון יכלול את הפונקציונליות של סביבה וירטואלית. הסקריפט עצמו יוסיף דפים מוכנים למאגר הציבורי.

כלים לפתרון

כלים בהם נשתמש כדי לפתור את הבעיה:

• פעולות GitHub;
• פייתון 3.7;
• שַׁקנַאי;
• גיט;
• דפי GitHub.

הפתרון

לכן, לאחר היכרות קטנה עם התיעוד והבנת אופן כתיבת סקריפטים ל-Actions, התברר כי המנגנון הזה יפתור לחלוטין את הבעיה שנוצרה. בזמן הכתיבה, עליך להירשם כדי להשתמש בפונקציונליות זו. לבדיקת בטא!

תיאור הפונקציונליות החדשה של Github עצמה

כתיבת סקריפט Actions מתחילה ביצירת קובץ בשם בתיקייה .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) לאחר מכן, עליך לבחור את הפעולה/טריגר שיפעיל את הסקריפט, במקרה שלנו זו הדחיפה הרגילה של commit חדש למאגר.

on:
  push

2) נשאיר גם את התמונה שעל בסיסה יושק הסקריפט כדוגמה, שכן אובונטו די מרוצה מהפונקציונליות הדרושה. מסתכל על כלים זמינים מתברר שזו יכולה להיות כל תמונה הכרחית או פשוט נוחה (או קונטיינר Docker המבוסס עליה).

  build:
    runs-on: ubuntu-latest

3) בשלבים נקים תחילה את הסביבה להכנה לעבודה העיקרית.

3.1) עבור אל הסניף שאנו צריכים (שלב סטנדרטי checkout):

- uses: actions/checkout@v1

3.2) התקן את Python:

    - 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) בואו ניצור הודעת commit, נבצע את השינויים ונדחוף אותם למאגר. כך שה-commit אינו לשווא ולכן אינו מייצר שגיאה ב-bash (תוצאת הפלט אינה 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, Actions יעשו הכל בעצמם. אם הסקריפט קורס באופן בלתי צפוי, תישלח הודעה למייל שלך.

קוד מלא

אני אשאיר את גרסת העבודה שלי, שבה השלב האחרון מוסיף שליחת הודעה על כך ש-commit נדחף למאגר הראשי.

נעשה שימוש בסודות המתוארים לעיל, כאשר מתווספים אסימון הבוט ומזהה המשתמש שאליו יש לשלוח את ההודעה.

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