>  기사  >  PHP 프레임워크  >  GitHub Actions를 사용하여 Laravel 프로젝트를 자동으로 배포하는 방법에 대해 이야기해 보겠습니다.

GitHub Actions를 사용하여 Laravel 프로젝트를 자동으로 배포하는 방법에 대해 이야기해 보겠습니다.

青灯夜游
青灯夜游앞으로
2022-10-19 20:11:091241검색

GitHub Actions를 사용하여 Laravel 프로젝트를 자동으로 배포하는 방법에 대해 이야기해 보겠습니다.

GitHub Actions를 사용하여 Laravel 프로젝트를 자동으로 배포하는 방법은 무엇입니까? 이 글에서는 Laravel 애플리케이션을 VPS에 무료로 자동 배포하는 방법을 안내해 드리겠습니다.

현장 설정 중...

저는 VPS에 배포된 Laravel 프로젝트를 진행하는 소규모 팀의 일원입니다. 각 팀원은 특정 작업을 수행하며, 프로덕션 준비가 되면 GitHub Repo에 푸시되는 모든 변경 사항을 배포하기 위해 누군가 항상 서버에 액세스해야 합니다.

이것은 우리 모두에게 규모와 예산 내에서 솔루션을 찾아야 하는 매우 반복적이고 불쾌한 작업입니다. 그래서 우리는 강력한 Github Actions을 사용하여 작업 흐름 시간을 자동화합니다.

워크플로 설정 가이드의 단순화된 버전을 살펴보겠습니다.

Assumptions

이 가이드에서는 다음 사항을 확인한다고 가정합니다.

  • Laravel 애플리케이션을 실행하고 Git이 설치되도록 구성된 Linux 서버가 있습니다.

  • Laravel 애플리케이션 Github 저장소가 있습니다. 내 마지막 기사의 첫 두 부분인 free-serverless-laravel-deployment를 따라가실 수 있습니다.

작동 방식

일반적인 워크플로에서 개발자는 특정 작업에 대한 새 브랜치를 생성하고 main/master 브랜치에 풀 요청을 발행합니다. 또는 main/master 분기를 직접 변경하고(권장하지 않음) 푸시하세요. main/master 分支发出拉取请求,或自行在 main/master 分支上进行更改 (不可取) 并推送。

pull request 和 push 都是我们可以通过 Github Actions 订阅的给定分支上的事件。因此,我们可以定义一组指令,当给定事件在我们的仓库上发生时应该执行这些指令。这些指令可能正在运行我们的 TestsBuilds, 和 Deployments

创建部署脚本

我们要做的第一件事是创建一个部署脚本,其中包含部署和运行我们的应用程序所需的所有命令。

在应用程序的根目录中创建一个名为 .scripts 的文件夹。

在 .scripts 目录中创建一个名为 deploy.sh 的文件,其内容如下。

#!/bin/bash
set -e

echo "Deployment started ..."

# Enter maintenance mode or return true
# if already is in maintenance mode
(php artisan down) || true

# Pull the latest version of the app
git pull origin production

# Install composer dependencies
composer install --no-dev --no-interaction --prefer-dist --optimize-autoloader

# Clear the old cache
php artisan clear-compiled

# Recreate cache
php artisan optimize

# Compile npm assets
npm run prod

# Run database migrations
php artisan migrate --force

# Exit maintenance mode
php artisan up

echo "Deployment finished!"

请参阅脚本的注释以了解我们在每一行上所做的事情。

创建工作流

Github 操作工作流是一组指令,其中包含可以在我们上面提到的事件上触发的不同任务作业和步骤。

仓库的工作流存储在应用程序根目录的 .github/workflows 中。

在 .github/workflows 文件夹中创建一个名为 deploy.yml 的文件,其中包含以下内容。

name: Deploy

# Trigger the workflow on push and 
# pull request events on the production branch
on:
  push:
    branches:
      - production
  pull_request:
    branches:
      - production

# Authenticate to the the server via ssh 
# and run our deployment script 
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Deploy to server
        uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.HOST }}
          username: ${{ secrets.USERNAME }}
          port: ${{ secrets.PORT }}
          key: ${{ secrets.SSHKEY }}
          script: "cd /var/www/html && ./.scripts/deploy.sh"

提交新创建的文件

现在我们已经为我们的自动化创建了所有必要的文件,让我们使用以下命令提交它们。

$ git add deploy.sh deploy.yml 
$ git commit -m "Deployment automation"

创建部署分支并推送到 Github

如果您注意到我们的 deploy.sh 和 deploy.yml 文件,我们提到了一个名为 production 的分支。我们将使用此分支添加通过 push 或 pull request 可用于生产的提交。

使用以下 git 命令为您的存储库创建此分支并将它们推送到 GitHub。

$ git checkout -b production 
$ git push -u origin production

设置 ssh 密钥

是时候在我们的服务器和 Github 之间建立连接了。

为此,我们首先需要在我们的服务器上生成一个新的 ssh 密钥对。

在您的服务器上运行此命令以生成 ssh 密钥。

$ ssh-keygen -t rsa -b 4096 -C "email@example.com"

当提示输入文件名和密码时,只需按 Enter 并接受默认值。

这将在您的根目录 .ssh/

풀 요청push는 둘 다 Github Actions를 통해 구독할 수 있는 특정 브랜치의 이벤트입니다. 따라서 저장소에서 특정 이벤트가 발생할 때 실행되어야 하는 일련의 명령을 정의할 수 있습니다. 이러한 지침은 테스트, 빌드배포를 실행하는 것일 수 있습니다.

배포 스크립트 만들기
🎜가장 먼저 해야 할 일은 애플리케이션을 배포하고 실행하는 데 필요한 모든 명령이 포함된 배포 스크립트를 만드는 것입니다. 🎜🎜애플리케이션의 루트 디렉터리에 .scripts라는 폴더를 만듭니다. 🎜🎜다음 내용을 포함하여 .scripts 디렉터리에 deploy.sh라는 파일을 만듭니다. 🎜🎜
$ eval "$(ssh-agent -s)"$ ssh-add ~/.ssh/id_rsa
🎜🎜각 줄에서 우리가 무엇을 하고 있는지 보려면 스크립트의 설명을 참조하세요. 🎜

🎜워크플로 만들기🎜🎜🎜Github 액션 워크플로는 위에서 언급한 이벤트에서 실행될 수 있는 다양한 작업 작업과 단계가 포함된 지침 세트입니다. 🎜🎜웨어하우스의 워크플로는 애플리케이션 루트 디렉터리의 .github/workflows에 저장됩니다. 🎜🎜다음 내용을 포함하여 .github/workflows 폴더에 deploy.yml이라는 파일을 만듭니다. 🎜🎜
$ cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
🎜

🎜새로 생성된 파일 제출🎜🎜🎜이제 자동화에 필요한 모든 파일을 생성했으므로 다음 명령을 사용하여 제출해 보겠습니다. 🎜🎜
$ cat ~/.ssh/id_rsa
🎜

🎜배포 브랜치를 생성하고 Github에 푸시🎜🎜🎜deploy.shdeploy.yml 파일을 발견했다면 에서 production이라는 분기를 언급했습니다. 이 분기를 사용하여 push 또는 pull 요청을 통해 프로덕션에 사용할 수 있는 커밋을 추가합니다. 🎜🎜다음 git 명령을 사용하여 저장소에 대한 이 브랜치를 생성하고 GitHub에 푸시하세요. 🎜🎜
$ cat ~/.ssh/id_rsa.pub
🎜

🎜Ssh 키 설정🎜🎜🎜이제 서버와 Github 간의 연결을 설정할 차례입니다. 🎜🎜이를 위해서는 먼저 서버에서 새로운 SSH 키 쌍을 생성해야 합니다. 🎜🎜서버에서 이 명령을 실행하여 SSH 키를 생성하세요. 🎜🎜
git remote set-url origin git@github.com:USERNAME/REPOSITORY.git
git fetch
🎜🎜파일 이름과 비밀번호를 묻는 메시지가 나타나면 Enter 키를 누르고 기본값을 수락하세요. 🎜🎜이렇게 하면 루트 .ssh/ 폴더에 공개 및 비공개 SSH 키 2개가 생성됩니다. 🎜🎜이제 다음 명령을 사용하여 새로 생성된 SSH 개인 키를 ssh-agent에 추가하세요. 🎜🎜rreee🎜

让我们使用以下命令将我们的公钥添加到我们服务器上的 authorized_keys 文件中。

$ cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys

复制 ssh 密钥到 Github

我们的上述设置将允许:-

1\。 Github Actions 向我们的服务器验证自己并运行我们的 deploy.sh 脚本。

为此,我们必须让 Github 知道如何对我们的服务器进行身份验证。

当我们准备好上面的 ssh 密钥时,它将与服务器的 HOST, ssh PORT, ssh 私钥的 KEY, 以及服务器的 USERNAME 一起提供给 GitHub。

为此,请在浏览器上访问您的 Github 帐户并打开您的仓库。

点击 settings,如下图

Github setting

在侧边栏菜单上单击secrets

github add button

在 Action Secret 页面上,单击 new repository secret。

add button

在new secret页面上,逐个添加以下密钥。

HOST

HOST 是您的服务器 IP 地址,在名称字段中输入 HOST 关键字,在值中输入您的服务器 IP 地址。

PORT

PORT 是您的 ssh 端口。在名称中使用 PORT 关键字并在值中使用 22 以使用默认 ssh 端口。

SSHKEY

SSHKEY 是我们在服务器上生成的私有 ssh 密钥。通常您不会与任何人共享您的私人 ssh 密钥,但由于我们正在进行自动化,因此这是必需的。

使用 SSHKEY 关键字作为名称字段。

要复制您的私钥值,请转到您的服务器并运行以下命令。

$ cat ~/.ssh/id_rsa

这将在您的终端上打印您的私人 ssh 密钥,将其复制并粘贴到值字段中。

USERNAME

最后一个是您要进行身份验证的 USERNAME 。

为此,您可以在服务器上运行 whoami 并获取值。然后在名称字段中使用 USERNAME 关键字并在值中添加过去。

完成后,您的秘密应该看起来像这样

github secrets

2\。我们的服务器向 Github 进行身份验证并获取我们存储库中的最新提交。

为了让 Github 允许访问我们的服务器,我们必须提供我们之前生成的 ssh 公钥。

如果我们有多个仓库,我们可以在帐户级别提供公钥,但如果它只是一个仓库,我们可以在仓库中提供它,并且只允许访问我们帐户上的那个仓库。

为此,请再次转到您的仓库设置并单击部署密。

deploy keys

添加部署密钥..

add deploy keys

给它起一个有助于记住服务器的标题,例如 PROD_SERVER

Image description

对于关键字段值,转到您的服务器并使用以下命令打印您的公钥并复制它。

$ cat ~/.ssh/id_rsa.pub

不要检查允许写访问,只需单击添加密钥按钮。

最后一件事是更改我们服务器上的远程源以使用 SSH 而不是 HTTPS 并执行获取以获取服务器上的新提交。

为此,请转到您的 Github 存储库并单击 code 按钮并复制 ssh 选项卡上的链接。

Image description

然后在您的服务器上转到您部署的应用程序目录,最常见的是 /var/html/www 并运行以下命令。

git remote set-url origin git@github.com:USERNAME/REPOSITORY.git
git fetch

将 URL 替换为您复制的 URL。

好了,我的朋友们,你现在有了 Laravel 应用程序部署自动化。 创建一个测试提交并将其推送到您的 production 分支,以见证奇迹发生。

您可以通过为您的测试构建、暂存环境等添加更多工作流来为它疯狂……

原文地址:https://dev.to/kenean50/automate-your-laravel-app-deployment-with-github-actions-2g7j

译文地址:https://learnku.com/laravel/t/69131

【관련 추천: laravel 비디오 튜토리얼

위 내용은 GitHub Actions를 사용하여 Laravel 프로젝트를 자동으로 배포하는 방법에 대해 이야기해 보겠습니다.의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명:
이 기사는 learnku.com에서 복제됩니다. 침해가 있는 경우 admin@php.cn으로 문의하시기 바랍니다. 삭제