Англійська мова для GitHub Actions Reusable Workflows

Дублювання тих самих кроків CI через десятки сховищ з часом стає неможливим, і існують потоки роботи з повторним використанням, спеціально розроблені для вирішення цього — цей словник дозволяє вам обговорювати механізм точно, замість того, щоб називати все «спільним конвеєром»

Ключовий словник

** Повторно використовуваний робочий процес ** — файл робочого процесу, визначений тригером workflow_call, розроблений для виклику з інших робочих процесів, а не для виконання безпосередньо, що дозволяє командам централізувати логіку CI замість копіювання і вставлення її у кожне сховище. “Замість підтримки майже ідентичних кроків розгортання в п’ятнадцяти репо, ми перенесли логіку в один багаторазовий робочий процес — тепер кожне репо просто викликає його, і виправлення в одному місці застосовується всюди.”

** Workflow_ call trigger ** — особливий тип тригера, який робить робочий потік викликаним іншими робочими потоками, визначаючи вхідні дані, секрети і вивід, які він приймає, відрізняючись від тригерів, таких як push або pull_request, які відповідають на події сховища безпосередньо.

• “Цей поток робіт не можна викликати з іншого потоку — він має лише тригер push. Він потребує доданого тригера workflow_call, з вхідними даними і секретами, які він повинен приймати явно оголошені.”*

** Вхідний ** — параметр з типом, який було оголошено потоком робіт з можливістю повторного використання і передано потоком робіт з викликом, що дозволяє спільній логіці поводитися по- різному залежно від контексту, наприклад, від середовища, у якому буде розгорнуто потоки робіт. “Ми не потребуємо двох майже ідентичних потоків для стадіювання та виробництва — додайте вхід environment до того, який ми маємо, і дозвольте викликанню потоку пройти в тому місці, де це потрібно.”

** Спадкування секретів ** — параметр secrets: inherit, за допомогою якого всі секрети потоку виклику автоматично передаються потоку повторного використання, замість того, щоб кожний секрет було внесено до списку і передано окремо.

• “Ми отримували помилку « не визначений секрет », оскільки поток виклику не використовував успадкування секретів — він передавав секрети окремо і пропустив один, який насправді потрібен потоку повторного використання.” *

** Складена дія ** — інший механізм повторного використання, який пакує послідовність кроків у єдиний крок, який можна використовувати знову, з посиланням на uses: всередині завдання, краще підходить для невеликого набору кроків, ніж для цілого завдання або конвеєра.

• “Тільки для цих трьох кроків налаштування, складна дія є кращим варіантом, ніж повний поток роботи з можливістю повторного використання — потоки роботи з можливістю повторного використання призначені для повторного використання цілих завдань, а не декількох кроків у межах одного завдання.” *

Звичайні фрази

• Чи є це дійсно кращим варіантом, чи є це просто одним з варіантів, які можна використовувати?»
• «Чи має цей робочий потік тригер workflow_call, або тільки тригер події?»
• Чи варіюється це залежно від вхідного сигналу, чи він потребує окремого потоку роботи, який можна використовувати повторно?»
• Чи ми використовуємо секрети успадкування тут, або передаємо секрети індивідуально?»
• Чи це повторно використовується в різних репо, або просто в різних роботах в тому ж репо?

Приклади висловлювань

Пропозиція рефактору у обговоренні команди:

• “Зараз у нас є така ж восьмикроковий послідовність розгортання, що дублюється у дванадцяти сховищах. Я б хотів витягнути його в багаторазовий робочий процес з тригером workflow_call, тому кожен репо просто викликає його з вхідними даними середовища замість підтримки власної копії.”*

Зневадження проблеми з секретами:

• “Збирання зазнало невдачі, оскільки поток роботи з повторним використанням не може знайти NPM_TOKEN — поток роботи з викликом передав секрети окремо і пропустив його. Перехід на secrets: inherit уникнув би цього класу помилок в майбутньому.»*

Пояснення вибору дизайну: “Ми використовували складну дію для кроків отримання і налаштування, а не повний поток роботи з можливістю повторного використання, тому що це лише три кроки, які спільно використовуються в рамках завдань одного і того ж сховища — поток роботи з можливістю повторного використання був би правильним вибором, якщо б нам потрібно було поділитись цим між окремими сховищами.”

Професійні поради

• Використовуйте повторно використовуваний поток робіт, особливо, коли одна і та ж логіка рівня завдання дублюється у декількох сховищах — для кроків, які спільно використовуються лише у одному сховищі, складна дія зазвичай є простішою.
• Заявити вхідні дані і секрети workflow_call тригера явно і документувати, що кожен з них контролює - неясний інтерфейс багаторазового використання робочого потоку перемагає мету централізації логіки в першу чергу.
• Віддавайте перевагу ** вводу ** перед дублюванням цілого потоку роботи, який можна використовувати знову і знову, для незначних змін, наприклад, зміни середовища або версії — дублювання потоку роботи знову створює навантаження на обслуговування, яке було призначено вилучити.
• Типовим є значення ** успадкування секретів **, якщо не існує певної причини для обмеження доступу до секретів потоку роботи з повторним використанням — передавання секретів окремо є більш чітким, але також є поширеним джерелом помилок « невизначених секретів », коли пізніше додається новий секрет.
• Використовуйте ** складну дію **, а не потоки робіт з повторним використанням, для невеликого набору кроків, які буде повторено у межах завдань одного сховища — підбір інструменту відповідно до обсягу дублювання уникне надмірної складності.

Практичні вправи

1. Пояснити різницю між потоком робіт з можливістю повторного використання і складною дією.
2. Описати, що робить тригер workflow_ call і чому він потрібен.
3. Напишіть речення, у якому поясните, що робить успадкування секретів і коли ви можете не використовувати його.

Mastering the Flow: Практична англійська для GitHub Actions

Давайте поглянемо правді в очі - навіть з найскладнішою автоматикою, чітке спілкування є ключовим. При обговоренні * GitHub Actions * багаторазових потоків роботи, особливо тих, що використовують концепції, такі як workflow_call і секретне успадкування, точна англійська може зробити всю різницю між гладко виконаним процесом і розчаруванням сеансу зневадження. У цьому розділі описано практичні вирази, які ви зустрінете під час співпраці, документування або розв’ язання проблем — виходячи за межі технічних визначення.

Одним з найбільших викликів є розуміння того, як секрети поширюються через багаторазові робочі потоки. Не завжди одразу зрозуміло, чому певна таємниця не доступна в певному контексті. Поширена фраза, що використовується під час розслідувань, це «таємне успадкування» — але пояснення цього чітко комусь, хто не знайомий з термінологією GitHub Actions, може бути складним. Замість того, щоб просто сказати « це не працює », спробуйте сформулювати це так: « Дія workflow_call не успадкувала необхідні секрети від батьківського потоку дій; це призвело до помилки під час доступу до [ресурсу]. » Це негайно повідомляє про основну проблему і звертає увагу на її корені — це важливий крок у розв’ язанні проблеми.

Іншою областю, де важливо чітке спілкування, є документування ваших потоків роботи, які можна використовувати повторно. Не просто перераховуйте вхідні дані; поясніть * чому * вони потрібні. Наприклад, замість «Вхідні дані: username, password,» розгляньте «Вхідні дані: username (вимагаються для автентифікації) і password (використовуються для доступу до API – зберігати безпечно як секрет GitHub)». Цей рівень деталізації забезпечує, що інші розуміють мету кожного вхідного даних і як він сприяє загальній функціональності робочого потоку.

Крім того, при запиті змін або наданні зворотнього зв’язку щодо існуючих потоків роботи, точність є найважливішою. Замість того, щоб сказати « Потрібно більше вхідних даних », спробуйте сказати « Я рекомендую додати вхідний даний environment_expression, щоб уможливити динамічне налаштування на основі середовища ». Таким чином ви продемонструєте глибше розуміння технології, за якою працює програма, і запропонуєте конкретну, реалізовувану пропозицію. Пам’ ятайте, що розробники часто покладаються на коротке повідомлення, коли описують проблеми або пропонують поліпшення — ясна, точна мова уникає неоднозначності і прискорює процес розв’ язання.

Ось приклад того, як workflow_call використовується для запуску іншої дії:

jobs:
  my_job:
    steps:
      - name: Trigger Another Workflow
        uses: actions/workflow-call@v3
        with:
          name: my_other_workflow
          inputs:
            data: ${{ steps.get_data.outputs.value }}

У цьому сценарії, робочий потік my_job викликає інший робочий потік з назвою my_other_workflow. Розділ inputs вказує, що my_other_workflow має отримати значення, передане з попереднього кроку, демонструючи, як потоки повторного використання можуть бути з’єднані разом для складних завдань автоматизації. Зрозуміти потік даних в рамках цих викликів є ключовим для ефективного зневадження і обслуговування.