Detect new release branch then schedule deployment on that branch

[Buyantugs]

Select Topic Area

Question

Body

I'm trying to implement a logic on github action:
We created new "release" branch when we ready to deploy. Actual build & deployment trigger must execute during the night hour.

I created 2 workflows on above requirement:

1. create release branch.yaml
2. deployment_with_schedule.yaml

The problem is second workflow unable to extract branch flag value from self-hosted runner machine.
Is there any alternative solution?

Workflow Code1:

name: Set Release Flag

on:
create:
branches:
- 'release-*' # Trigger when branches starting with 'release-' are created

jobs:
set-flag:
runs-on: self-hosted
steps:
- name: Create release flag
run: echo "release_ready=true" > release_flag.txt
- name: Upload release flag
uses: actions/upload-artifact@v3
with:
name: release-flag
path: release_flag.txt

Workflow Code 2:

name: Scheduled Deployment

on:
schedule:

• cron: '*/5 * * * *' # 11:40 AM Chicago time (17:40 UTC)
  workflow_dispatch: # Can be triggered manually or by another workflow dispatch

jobs:
check-flag:
runs-on: self-hosted
steps:
- name: Download release flag
uses: actions/download-artifact@v3
with:
name: release-flag
continue-on-error: true # Don't fail if flag is absent

 - name: Check for release readiness
   id: flag-check
   run: |
     if (Test-Path -Path "release_flag.txt") {
       $content = Get-Content -Path "release_flag.txt"
       if ($content -match "release_ready=true") {
         Write-Host "Release branch detected"
         echo "::set-output name=release_ready::true"
       } else {
         Write-Host "No release branch detected"
         echo "::set-output name=release_ready::false"
       }
     } else {
       Write-Host "release_flag.txt file does not exist."
       echo "::set-output name=release_ready::false"
     }
   shell: powershell

build:
if: needs.check-flag.outputs.release_ready == 'true'
runs-on: self-hosted
needs: check-flag
steps:
- name: Checkout code
uses: actions/checkout@v3

 - name: Build Project
   run: dotnet build --configuration Release

 - name: Publish Project
   run: dotnet publish -c Release -o ./output

 - name: Upload Build Artifacts
   uses: actions/upload-artifact@v3
   with:
     name: website
     path: ./output

deploy:
if: needs.check-flag.outputs.release_ready == 'true'
runs-on: self-hosted
needs: build
steps:
- name: Download Build Artifacts
uses: actions/download-artifact@v3
with:
name: website

 - name: Stop IIS
   run: Stop-Service -Name 'W3SVC'

 - name: Backup Existing Website
   run: |
     $backupFolder = "C:\inetpub\backup\$(Get-Date -Format 'yyyyMMddHHmmss')"
     $webRoot = "C:\inetpub\wwwroot\web1"
     New-Item -ItemType Directory -Path $backupFolder
     Copy-Item -Path $webRoot\* -Destination $backupFolder -Recurse
 - name: Deploy New Files
   run: |
     $webRoot = "C:\inetpub\wwwroot\web1"
     Remove-Item -Path $webRoot\* -Recurse -Force
     Copy-Item -Path $PWD\output\* -Destination $webRoot -Recurse
 - name: Start or Restart IIS
   run: |
     try { Restart-Service -Name 'W3SVC' -ErrorAction Stop }
     catch { Start-Sleep -Seconds 10; Restart-Service -Name 'W3SVC' }
 - name: Clear Release Flag

Error Message:
Run actions/download-artifact@v3 with: name: release-flag Starting download for release-flag Error: Unable to find any artifacts for the associated workflow

[21hs]

Selecione a área do tópico

Parece que você está tentando compartilhar informações entre dois fluxos de trabalho do GitHub Actions usando artefatos, mas está enfrentando problemas ao tentar acessar o artefato release-flag no segundo fluxo de trabalho (implantação_com_agendamento.yaml). O erro que você encontrou, "Unable to find any artifacts for the associated workflow", ocorre porque o segundo fluxo de trabalho não consegue encontrar o artefato gerado pelo primeiro fluxo de trabalho. Isso é esperado, pois os artefatos de um fluxo de trabalho só podem ser acessados por outros fluxos de trabalho dentro da mesma execução ou instância, e o actions/download-artifact não encontra o artefato se ele não foi gerado na mesma execução.

Problema Principal:
O artefato release_flag.txt criado no primeiro fluxo de trabalho não é acessível no segundo fluxo de trabalho devido à limitação de escopo dos artefatos: artefatos são armazenados e acessíveis apenas dentro da execução em que foram criados, e não podem ser acessados por outros fluxos de trabalho executados em momentos diferentes.

Solução: Usar Artifacts ou Outputs Persistentes (como repositório ou cache)
Aqui estão algumas abordagens que você pode considerar para resolver o problema e permitir a persistência do sinalizador entre os fluxos de trabalho:

1. Armazenar o sinalizador no repositório:
   Uma abordagem comum para persistir um sinalizador entre fluxos de trabalho é armazenar o arquivo release_flag.txt em um repositório Git, por exemplo, em uma branch ou em um diretório específico. Isso permitirá que qualquer fluxo de trabalho acesse o arquivo, independentemente de quando ele for executado.

Como implementar:

No primeiro fluxo de trabalho (fluxo de criação da branch), adicione uma etapa para fazer o commit e push do arquivo release_flag.txt para o repositório.
No segundo fluxo de trabalho (fluxo de implantação), adicione uma etapa para fazer o checkout do repositório e baixar o arquivo release_flag.txt.
Exemplo de alteração no fluxo de trabalho 1 (criação da branch):

jobs:
set-flag:
runs-on: auto-hospedado
steps:
- name: Criar sinalizador de lançamento
run: echo "release_ready=true" > release_flag.txt
- name: Configurar Git
run: |
git config --global user.email "you@example.com"
git config --global user.name "Your Name"
- name: Commit e push do sinalizador de lançamento
run: |
git add release_flag.txt
git commit -m "Adicionando sinalizador de lançamento"
git push origin release-${GITHUB_SHA}
Exemplo de alteração no fluxo de trabalho 2 (implantação):

jobs:
check-flag:
runs-on: auto-hospedado
steps:
- name: Checkout do repositório
uses: actions/checkout@v3
- name: Baixar sinalizador de lançamento
run: |
if [ -f "release_flag.txt" ]; then
echo "Sinalizador encontrado"
release_ready=true
else
echo "Sinalizador não encontrado"
release_ready=false
fi
2. Armazenar o sinalizador em um cache compartilhado:
Uma abordagem alternativa é usar o GitHub Actions Cache para armazenar o arquivo de sinalizador em um cache compartilhado entre os fluxos de trabalho. O cache pode ser recuperado no segundo fluxo de trabalho, mas tenha em mente que o cache tem uma validade (geralmente 7 dias) e não é uma solução persistente no longo prazo.

Exemplo de implementação usando cache:
Fluxo de trabalho 1 (criação do sinalizador):

jobs:
set-flag:
runs-on: auto-hospedado
steps:
- name: Criar sinalizador de lançamento
run: echo "release_ready=true" > release_flag.txt
- name: Salvar sinalizador no cache
uses: actions/cache@v3
with:
path: release_flag.txt
key: release_flag-${{ runner.os }}-${{ github.sha }}
Fluxo de trabalho 2 (implantação):

jobs:
check-flag:
runs-on: auto-hospedado
steps:
- name: Baixar sinalizador de lançamento do cache
uses: actions/cache@v3
with:
path: release_flag.txt
key: release_flag-${{ runner.os }}-${{ github.sha }}
restore-keys: |
release_flag-${{ runner.os }}-
- name: Verificar sinalizador de lançamento
run: |
if [ -f "release_flag.txt" ]; then
echo "Sinalizador encontrado"
release_ready=true
else
echo "Sinalizador não encontrado"
release_ready=false
fi
3. Usar o workflow_run para passar a saída de um fluxo de trabalho para outro:
Uma solução mais robusta seria usar o gatilho workflow_run para disparar o segundo fluxo de trabalho somente após o primeiro ser concluído. O fluxo de trabalho workflow_run permite que você execute o segundo fluxo de trabalho com base no sucesso ou falha de um fluxo de trabalho anterior. Nesse caso, o arquivo de sinalizador pode ser gerado no primeiro fluxo de trabalho e passado como variável ou output para o segundo fluxo de trabalho.

Exemplo de workflow_run:

on:
workflow_run:
workflows: ["Definir sinalizador de liberação"]
types:
- completed

jobs:
check-flag:
runs-on: auto-hospedado
steps:
- name: Baixar sinalizador de lançamento
run: |
if [ -f "release_flag.txt" ]; then
echo "Sinalizador encontrado"
release_ready=true
else
echo "Sinalizador não encontrado"
release_ready=false
Resumo das Soluções:
Armazenar no repositório: Commit e push do arquivo release_flag.txt em um branch específico.
Usar cache: Armazenar o sinalizador como um artefato em cache, embora tenha limitações de expiração.
Usar workflow_run: Passar a execução de um fluxo para outro com base na conclusão do primeiro fluxo.
A escolha entre essas soluções depende do seu caso específico, como a necessidade de persistência dos dados e da complexidade da sua arquitetura. Se a persistência do sinalizador for crítica, o armazenamento no repositório ou o uso de outputs entre fluxos de trabalho são as melhores opções.

[Buyantugs]

Thank you quick response. I'll use your approach on my end and let you know.