Observação: Executores hospedados em GitHub não são atualmente compatíveis com GitHub Enterprise Server. Você pode ver mais informações sobre suporte futuro planejado no Itinerário público do GitHub.
Introdução
Este guia explica como usar GitHub Actions para criar e implantar um projeto Python no Azure App Service.
Pré-requisitos
Antes de criar seu fluxo de trabalho de GitHub Actions, primeiro você precisa concluir as etapas de configuração a seguir:
-
Crie um plano do Azure App Service.
Por exemplo, você pode usar o CLI do Azure para criar um novo plano de App Service:
Shell az appservice plan create \ --resource-group MY_RESOURCE_GROUP \ --name MY_APP_SERVICE_PLAN \ --is-linux
No comando acima, substitua
MY_RESOURCE_GROUP
pelo seu Grupo de Recursos do Azure pré-existente, eMY_APP_SERVICE_PLAN
por um novo nome para o plano do App Service.Para obter mais informações, consulte a documentação do Azure usando o CLI do Azure:
- Para autenticação, consulte "Efetuar login com o CLI do Azure."
- Se você precisar criar um novo grupo de recursos, consulte "grupo az".
-
Crie um aplicativo web.
Por exemplo, você pode usar o CLI do Azure para criar um aplicativo web do com o tempo de execução do Python:
Shell az webapp create \ --name MY_WEBAPP_NAME \ --plan MY_APP_SERVICE_PLAN \ --resource-group MY_RESOURCE_GROUP \ --runtime "python|3.8"
No comando acima, substitua os parâmetros pelos seus próprios valores, em que
MY_WEBAPP_NAME
é um novo nome para o aplicativo web. -
Configure um perfil de publicação do Azure e crie um segredo de
AZURE_WEBAPP_PUBLISH_PROFILE
.Gere suas credenciais de implantação do Azure usando um perfil de publicação. Para obter mais informações, consulte "Gerar credenciais de implantação" na documentação do Azure.
No seu repositório GitHub, crie um segredo denominado
AZURE_WEBAPP_PUBLISH_PROFILE
que contém o conteúdo do perfil de publicação. Para obter mais informações sobre a criação de segredos, consulte "Segredos criptografados". -
Adicione uma configuração do aplicativo chamado
SCM_DO_BUILD_DURING_DEPLOYMENT
e defina o valor como1
. -
Opcionalmente, configure um ambiente de implantação. Os ambientes são usados para descrever um alvo geral de implantação como
produção
,preparo
oudesenvolvimento
. Quando um fluxo de trabalho de GitHub Actions é implantado em um ambiente, o ambiente é exibido na página principal do repositório. Você pode usar ambientes para exigir aprovação para um trabalho para prosseguir, restringir quais branches podem acionar um fluxo de trabalho ou limitar o acesso a segredos. Para obter mais informações sobre criar ambientes, consulte "Usando ambientes para implantação".
Criar o fluxo de trabalho
Depois de preencher os pré-requisitos, você pode prosseguir com a criação do fluxo de trabalho.
O exemplo a seguir mostra como criar e implantar um projeto Python no Azure App Service quando há um push para o branch principal
.
Certifique-se de definir AZURE_WEBAPP_NAME
na chave de fluxo de trabalho env
como o nome do aplicativo web que você criou. Se você usa uma versão do Python diferente de 3.8
, altere o PYTHON_VERSION
para a versão que você usa.
Se você configurou um ambiente de implementação, altere o valor do ambiente
para o nome do seu ambiente. Se você não configurou um ambiente, exclua a chave ambiente
.
# This workflow uses actions that are not certified by GitHub.
# São fornecidas por terceiros e regidas por
# termos de serviço, política de privacidade e suporte separados
# documentação.
name: Build and deploy Python app to Azure Web App
env:
AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name
PYTHON_VERSION: '3.8' # set this to the Python version to use
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python version
uses: actions/setup-python@v2
with:
python-version: ${{ env.PYTHON_VERSION }}
- name: Create and start virtual environment
run: |
python -m venv venv
source venv/bin/activate
- name: Set up dependency caching for faster installs
uses: actions/cache@v2
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: pip install -r requirements.txt
# Optional: Add a step to run tests here (PyTest, Django test suites, etc.)
- name: Upload artifact for deployment jobs
uses: actions/upload-artifact@v2
with:
name: python-app
path: |
.
!venv/
deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: 'production'
url: ${{ steps.deploy-to-webapp.outputs.webapp-url }}
steps:
- name: Download artifact from build job
uses: actions/download-artifact@v2
with:
name: python-app
path: .
- name: 'Deploy to Azure Web App'
id: deploy-to-webapp
uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e
with:
app-name: ${{ env.AZURE_WEBAPP_NAME }}
publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
Recursos adicionais
Os seguintes recursos também podem ser úteis:
- Para o fluxo de trabalho inicial original, consulte
azure-webapps-python.yml
no repositóriostarter-workflows
de GitHub Actions. - A ação usada para fazer a implantação do aplicativo web é a ação oficial
Azure/webapps-deploy
do Azure. - Para obter mais exemplos de fluxos de trabalho do GitHub Action que fazem a implantação no Azure, consulte o repositório actions-workflow-samples.