Czasami workflow GitHub Actions bywa kapryśny i nie udaje się z powodu losowych powodów. Zobaczmy, jak automatycznie ponownie go uruchomić, aby zaoszczędzić czas.
Uwielbiamy GitHub Actions. Jest potężny i oferuje hojny darmowy poziom.
W miarę jak nasz projekt rośnie, dodaliśmy coraz więcej testów integracyjnych do uruchomienia w naszym workflow GitHub Actions. Podobnie jak w innych świetnych projektach, uruchamiamy nasze testy dla każdego pull requesta, pushu i wydania.
Niemniej jednak, z powodu natury testów integracyjnych, czasami nasz workflow nie udaje się z losowych powodów. Może to być problem z siecią, czkawka przeglądarki lub inne powody, które trudno odtworzyć.
Kiedy workflow zawodzi, musimy ręcznie go ponownie uruchomić. Na początku to nie jest duży problem, ale jest to nadal irytujące dla deweloperów o wysokiej wydajności, takich jak my.
W momencie pisania tego tekstu, GitHub Actions nie oferuje wbudowanego sposobu automatycznego ponownego uruchamiania nieudanego workflow. Przeanalizujmy więc to i zobaczmy, jak możemy to osiągnąć.
Kiedy workflow NIE działa i nie powiodło się, możesz ręcznie go ponownie uruchomić, klikając przycisk "Re-run jobs". Pojawi się menu rozwijane z opcją "Re-run failed jobs", która pozwala pominąć udane zadania.
Pomysł jest prosty:
Oczywiście, nie możemy tego zrobić w tym samym workflow, ponieważ workflow nie może nic zrobić, gdy nie działa. Więc potrzebujemy innego workflow, aby monitorować status poprzedniego workflow i wyzwolić akcję ponownego uruchomienia. Można to zilustrować następująco:
%3btext-align:center%3b%7d%23mermaid-0 .edgeLabel p%7bbackground-color:rgba(232%2c232%2c232%2c 0.8)%3b%7d%23mermaid-0 .edgeLabel rect%7bopacity:0.5%3bbackground-color:rgba(232%2c232%2c232%2c 0.8)%3bfill:rgba(232%2c232%2c232%2c 0.8)%3b%7d%23mermaid-0 .labelBkg%7bbackground-color:rgba(232%2c 232%2c 232%2c 0.5)%3b%7d%23mermaid-0 .cluster rect%7bfill:%23ffffde%3bstroke:%23aaaa33%3bstroke-width:1px%3b%7d%23mermaid-0 .cluster text%7bfill:%23333%3b%7d%23mermaid-0 .cluster span%7bcolor:%23333%3b%7d%23mermaid-0 div.mermaidTooltip%7bposition:absolute%3btext-align:center%3bmax-width:200px%3bpadding:2px%3bfont-family:arial%2csans-serif%3bfont-size:12px%3bbackground:hsl(80%2c 100%25%2c 96.2745098039%25)%3bborder:1px solid %23aaaa33%3bborder-radius:2px%3bpointer-events:none%3bz-index:100%3b%7d%23mermaid-0 .flowchartTitleText%7btext-anchor:middle%3bfont-size:18px%3bfill:%23333%3b%7d%23mermaid-0 rect.text%7bfill:none%3bstroke-width:0%3b%7d%23mermaid-0 .icon-shape%2c%23mermaid-0 .image-shape%7bbackground-color:rgba(232%2c232%2c232%2c 0.8)%3btext-align:center%3b%7d%23mermaid-0 .icon-shape p%2c%23mermaid-0 .image-shape p%7bbackground-color:rgba(232%2c232%2c232%2c 0.8)%3bpadding:2px%3b%7d%23mermaid-0 .icon-shape rect%2c%23mermaid-0 .image-shape rect%7bopacity:0.5%3bbackground-color:rgba(232%2c232%2c232%2c 0.8)%3bfill:rgba(232%2c232%2c232%2c 0.8)%3b%7d%23mermaid-0 :root%7b--mermaid-font-family:arial%2csans-serif%3b%7d%3c/style%3e%3cg%3e%3cmarker orient='auto' markerHeight='8' markerWidth='8' markerUnits='userSpaceOnUse' refY='5' refX='5' viewBox='0 0 10 10' class='marker flowchart-v2' id='mermaid-0_flowchart-v2-pointEnd'%3e%3cpath style='stroke-width: 1%3b stroke-dasharray: 1%2c 0%3b' class='arrowMarkerPath' d='M 0 0 L 10 5 L 0 10 z'/%3e%3c/marker%3e%3cmarker orient='auto' markerHeight='8' markerWidth='8' markerUnits='userSpaceOnUse' refY='5' refX='4.5' viewBox='0 0 10 10' class='marker flowchart-v2' id='mermaid-0_flowchart-v2-pointStart'%3e%3cpath style='stroke-width: 1%3b stroke-dasharray: 1%2c 0%3b' class='arrowMarkerPath' d='M 0 5 L 10 10 L 10 0 z'/%3e%3c/marker%3e%3cmarker orient='auto' markerHeight='11' markerWidth='11' markerUnits='userSpaceOnUse' refY='5' refX='11' viewBox='0 0 10 10' class='marker flowchart-v2' id='mermaid-0_flowchart-v2-circleEnd'%3e%3ccircle style='stroke-width: 1%3b stroke-dasharray: 1%2c 0%3b' class='arrowMarkerPath' r='5' cy='5' cx='5'/%3e%3c/marker%3e%3cmarker orient='auto' markerHeight='11' markerWidth='11' markerUnits='userSpaceOnUse' refY='5' refX='-1' viewBox='0 0 10 10' class='marker flowchart-v2' id='mermaid-0_flowchart-v2-circleStart'%3e%3ccircle style='stroke-width: 1%3b stroke-dasharray: 1%2c 0%3b' class='arrowMarkerPath' r='5' cy='5' cx='5'/%3e%3c/marker%3e%3cmarker orient='auto' markerHeight='11' markerWidth='11' markerUnits='userSpaceOnUse' refY='5.2' refX='12' viewBox='0 0 11 11' class='marker cross flowchart-v2' id='mermaid-0_flowchart-v2-crossEnd'%3e%3cpath style='stroke-width: 2%3b stroke-dasharray: 1%2c 0%3b' class='arrowMarkerPath' d='M 1%2c1 l 9%2c9 M 10%2c1 l -9%2c9'/%3e%3c/marker%3e%3cmarker orient='auto' markerHeight='11' markerWidth='11' markerUnits='userSpaceOnUse' refY='5.2' refX='-1' viewBox='0 0 11 11' class='marker cross flowchart-v2' id='mermaid-0_flowchart-v2-crossStart'%3e%3cpath style='stroke-width: 2%3b stroke-dasharray: 1%2c 0%3b' class='arrowMarkerPath' d='M 1%2c1 l 9%2c9 M 10%2c1 l -9%2c9'/%3e%3c/marker%3e%3cg class='root'%3e%3cg class='clusters'%3e%3cg data-look='classic' id='subGraph1' class='cluster'%3e%3crect height='252' width='581.484375' y='8' x='659.40625' style=''/%3e%3cg transform='translate(850.1484375%2c 8)' class='cluster-label'%3e%3cforeignObject height='48' width='200'%3e%3cdiv style='display: table%3b white-space: break-spaces%3b line-height: 1.5%3b max-width: 200px%3b text-align: center%3b width: 200px%3b' xmlns='http://www.w3.org/1999/xhtml'%3e%3cspan class='nodeLabel'%3e%3cp%3eWorkflow ponownego uruchomienia%3c/p%3e%3c/span%3e%3c/div%3e%3c/foreignObject%3e%3c/g%3e%3c/g%3e%3cg data-look='classic' id='subGraph0' class='cluster'%3e%3crect height='148' width='601.40625' y='108' x='8' style=''/%3e%3cg transform='translate(240.234375%2c 108)' class='cluster-label'%3e%3cforeignObject height='24' width='136.9375'%3e%3cdiv style='display: table-cell%3b white-space: nowrap%3b line-height: 1.5%3b max-width: 200px%3b text-align: center%3b' xmlns='http://www.w3.org/1999/xhtml'%3e%3cspan class='nodeLabel'%3e%3cp%3ePierwotny workflow%3c/p%3e%3c/span%3e%3c/div%3e%3c/foreignObject%3e%3c/g%3e%3c/g%3e%3c/g%3e%3cg class='edgePaths'%3e%3cpath marker-end='url(%23mermaid-0_flowchart-v2-pointEnd)' style='' class='edge-thickness-normal edge-pattern-solid edge-thickness-normal edge-pattern-solid flowchart-link' id='L_A_B_0' d='M280%2c182.5L286.159%2c182.417C292.318%2c182.333%2c304.635%2c182.167%2c316.37%2c182.083C328.104%2c182%2c339.255%2c182%2c344.831%2c182L350.406%2c182'/%3e%3cpath marker-end='url(%23mermaid-0_flowchart-v2-pointEnd)' style='' class='edge-thickness-normal edge-pattern-solid edge-thickness-normal edge-pattern-solid flowchart-link' id='L_B_D_1' d='M584.406%2c182L588.573%2c182C592.74%2c182%2c601.073%2c182%2c609.406%2c182C617.74%2c182%2c626.073%2c182%2c634.406%2c182C642.74%2c182%2c651.073%2c182%2c658.823%2c182.07C666.573%2c182.141%2c673.74%2c182.281%2c677.324%2c182.351L680.907%2c182.422'/%3e%3cpath marker-end='url(%23mermaid-0_flowchart-v2-pointEnd)' style='' class='edge-thickness-normal edge-pattern-solid edge-thickness-normal edge-pattern-solid flowchart-link' id='L_D_E_2' d='M827.59%2c163L847.731%2c149.5C867.873%2c136%2c908.155%2c109%2c933.872%2c95.5C959.589%2c82%2c970.74%2c82%2c976.315%2c82L981.891%2c82'/%3e%3cpath marker-end='url(%23mermaid-0_flowchart-v2-pointEnd)' style='' class='edge-thickness-normal edge-pattern-solid edge-thickness-normal edge-pattern-solid flowchart-link' id='L_D_F_3' d='M911.484%2c182.5L917.643%2c182.417C923.802%2c182.333%2c936.12%2c182.167%2c960.449%2c183.99C984.778%2c185.814%2c1021.119%2c189.628%2c1039.289%2c191.535L1057.459%2c193.442'/%3e%3cpath marker-end='url(%23mermaid-0_flowchart-v2-pointEnd)' style='' class='edge-thickness-normal edge-pattern-solid edge-thickness-normal edge-pattern-solid flowchart-link' id='L_F_D_4' d='M1061.438%2c203.435L1042.604%2c206.029C1023.771%2c208.623%2c986.104%2c213.812%2c956.12%2c213.728C926.135%2c213.645%2c903.832%2c208.289%2c892.681%2c205.612L881.53%2c202.934'/%3e%3c/g%3e%3cg class='edgeLabels'%3e%3cg transform='translate(316.953125%2c 182)' class='edgeLabel'%3e%3cg transform='translate(-12.453125%2c -12)' class='label'%3e%3cforeignObject height='24' width='24.90625'%3e%3cdiv style='display: table-cell%3b white-space: nowrap%3b line-height: 1.5%3b max-width: 200px%3b text-align: center%3b' class='labelBkg' xmlns='http://www.w3.org/1999/xhtml'%3e%3cspan class='edgeLabel'%3e%3cp%3eTak%3c/p%3e%3c/span%3e%3c/div%3e%3c/foreignObject%3e%3c/g%3e%3c/g%3e%3cg class='edgeLabel'%3e%3cg transform='translate(0%2c 0)' class='label'%3e%3cforeignObject height='0' width='0'%3e%3cdiv style='display: table-cell%3b white-space: nowrap%3b line-height: 1.5%3b max-width: 200px%3b text-align: center%3b' class='labelBkg' xmlns='http://www.w3.org/1999/xhtml'%3e%3cspan class='edgeLabel'%3e%3c/span%3e%3c/div%3e%3c/foreignObject%3e%3c/g%3e%3c/g%3e%3cg transform='translate(948.4375%2c 82)' class='edgeLabel'%3e%3cg transform='translate(-12.0078125%2c -12)' class='label'%3e%3cforeignObject height='24' width='24.015625'%3e%3cdiv style='display: table-cell%3b white-space: nowrap%3b line-height: 1.5%3b max-width: 200px%3b text-align: center%3b' class='labelBkg' xmlns='http://www.w3.org/1999/xhtml'%3e%3cspan class='edgeLabel'%3e%3cp%3eNie%3c/p%3e%3c/span%3e%3c/div%3e%3c/foreignObject%3e%3c/g%3e%3c/g%3e%3cg transform='translate(948.4375%2c 182)' class='edgeLabel'%3e%3cg transform='translate(-12.453125%2c -12)' class='label'%3e%3cforeignObject height='24' width='24.90625'%3e%3cdiv style='display: table-cell%3b white-space: nowrap%3b line-height: 1.5%3b max-width: 200px%3b text-align: center%3b' class='labelBkg' xmlns='http://www.w3.org/1999/xhtml'%3e%3cspan class='edgeLabel'%3e%3cp%3eTak%3c/p%3e%3c/span%3e%3c/div%3e%3c/foreignObject%3e%3c/g%3e%3c/g%3e%3cg class='edgeLabel'%3e%3cg transform='translate(0%2c 0)' class='label'%3e%3cforeignObject height='0' width='0'%3e%3cdiv style='display: table-cell%3b white-space: nowrap%3b line-height: 1.5%3b max-width: 200px%3b text-align: center%3b' class='labelBkg' xmlns='http://www.w3.org/1999/xhtml'%3e%3cspan class='edgeLabel'%3e%3c/span%3e%3c/div%3e%3c/foreignObject%3e%3c/g%3e%3c/g%3e%3c/g%3e%3cg class='nodes'%3e%3cg transform='translate(156.25%2c 182)' id='flowchart-A-0' class='node default'%3e%3cpolygon transform='translate(-123.25%2c31.5)' class='label-container' points='15.75%2c0 230.75%2c0 246.5%2c-31.5 230.75%2c-63 15.75%2c-63 0%2c-31.5'/%3e%3cg transform='translate(-100%2c -24)' style='' class='label'%3e%3crect/%3e%3cforeignObject height='48' width='200'%3e%3cdiv style='display: table%3b white-space: break-spaces%3b line-height: 1.5%3b max-width: 200px%3b text-align: center%3b width: 200px%3b' xmlns='http://www.w3.org/1999/xhtml'%3e%3cspan class='nodeLabel'%3e%3cp%3ePierwotny workflow nie powiod%c5%82o si%c4%99%3f%3c/p%3e%3c/span%3e%3c/div%3e%3c/foreignObject%3e%3c/g%3e%3c/g%3e%3cg transform='translate(469.40625%2c 182)' id='flowchart-B-1' class='node default'%3e%3crect height='78' width='230' y='-39' x='-115' ry='5' rx='5' style='' class='basic label-container'/%3e%3cg transform='translate(-100%2c -24)' style='' class='label'%3e%3crect/%3e%3cforeignObject height='48' width='200'%3e%3cdiv style='display: table%3b white-space: break-spaces%3b line-height: 1.5%3b max-width: 200px%3b text-align: center%3b width: 200px%3b' xmlns='http://www.w3.org/1999/xhtml'%3e%3cspan class='nodeLabel'%3e%3cp%3eWyzwolenie workflow ponownego uruchomienia%3c/p%3e%3c/span%3e%3c/div%3e%3c/foreignObject%3e%3c/g%3e%3c/g%3e%3cg transform='translate(797.6953125%2c 182)' id='flowchart-D-3' class='node default'%3e%3cpolygon transform='translate(-113.2890625%2c19.5)' class='label-container' points='9.75%2c0 216.828125%2c0 226.578125%2c-19.5 216.828125%2c-39 9.75%2c-39 0%2c-19.5'/%3e%3cg transform='translate(-96.0390625%2c -12)' style='' class='label'%3e%3crect/%3e%3cforeignObject height='24' width='192.078125'%3e%3cdiv style='display: table-cell%3b white-space: nowrap%3b line-height: 1.5%3b max-width: 200px%3b text-align: center%3b' xmlns='http://www.w3.org/1999/xhtml'%3e%3cspan class='nodeLabel'%3e%3cp%3ePierwotny workflow dzia%c5%82a%3f%3c/p%3e%3c/span%3e%3c/div%3e%3c/foreignObject%3e%3c/g%3e%3c/g%3e%3cg transform='translate(1100.890625%2c 82)' id='flowchart-E-5' class='node default'%3e%3crect height='78' width='230' y='-39' x='-115' ry='5' rx='5' style='' class='basic label-container'/%3e%3cg transform='translate(-100%2c -24)' style='' class='label'%3e%3crect/%3e%3cforeignObject height='48' width='200'%3e%3cdiv style='display: table%3b white-space: break-spaces%3b line-height: 1.5%3b max-width: 200px%3b text-align: center%3b width: 200px%3b' xmlns='http://www.w3.org/1999/xhtml'%3e%3cspan class='nodeLabel'%3e%3cp%3eWyzwolenie pierwotnego workflow%3c/p%3e%3c/span%3e%3c/div%3e%3c/foreignObject%3e%3c/g%3e%3c/g%3e%3cg transform='translate(1100.890625%2c 198)' id='flowchart-F-7' class='node default'%3e%3crect height='54' width='78.90625' y='-27' x='-39.453125' ry='5' rx='5' style='' class='basic label-container'/%3e%3cg transform='translate(-24.453125%2c -12)' style='' class='label'%3e%3crect/%3e%3cforeignObject height='24' width='48.90625'%3e%3cdiv style='display: table-cell%3b white-space: nowrap%3b line-height: 1.5%3b max-width: 200px%3b text-align: center%3b' xmlns='http://www.w3.org/1999/xhtml'%3e%3cspan class='nodeLabel'%3e%3cp%3eCzekaj%3c/p%3e%3c/span%3e%3c/div%3e%3c/foreignObject%3e%3c/g%3e%3c/g%3e%3c/g%3e%3c/g%3e%3c/g%3e%3c/svg%3e)
Utwórz nowy plik workflow w swoim repozytorium, np. .github/workflows/rerun.yml:
Dzięki GitHub CLI możemy łatwo śledzić status workflow i ponownie go uruchomić za pomocą dwóch prostych poleceń:
gh run watch do śledzenia statusu workflow (dokumentacja tutaj).gh run rerun do ponownego uruchomienia workflow. Flaga --failed ponownie uruchamia tylko nieudane zadania (dokumentacja tutaj).Wszystko, co musisz zrobić, to podać run_id nieudanego workflowu, co można zrobić za pomocą kontekstu github.run_id. Na przykład, możesz wyzwolić workflow ponownego uruchomienia, dodając następujący krok do swojego pierwotnego workflow:
Warunek if: failure() wyzwoli krok tylko wtedy, gdy zadanie się nie uda. Warunek fromJSON(github.run_attempt) < 3 ponownie uruchomi tylko pierwsze 2 próby. Możesz dostosować liczbę do swoich potrzeb.
Ten krok używa polecenia gh workflow run, aby wyzwolić workflow ponownego uruchomienia. Zobacz dokumentację po więcej szczegółów.
Jeśli chcesz ponownie uruchomić workflow ponownego uruchamiania z gałęzi, która się nie powiodła, zamiast z domyślnej gałęzi, możesz użyć następującego polecenia:
Kontekst github.head_ref zostanie użyty, jeśli jest to pull request, w przeciwnym razie zostanie użyty github.ref_name.
Pomysł na to podejście pochodzi z tego komentarza w dyskusji na GitHubie.