Laravel - 在部署自定义 Artisan 命令时未部署 composer.json 文件

Posted 2023-02-19

【中文标题】Laravel - 在部署自定义 Artisan 命令时未部署 composer.json 文件

【英文标题】：Laravel - composer.json file not being deployed when also deploying custom Artisan commands

【发布时间】：2020-12-09 17:34:42

【问题描述】：

我有一个使用 GitLab 管道部署在测试和实时服务器上的 Laravel 应用程序。

我最近决定制作自己的 Artisan 命令，现在我想将其部署到测试服务器，但是这样做时我注意到以下错误：

In Application.php line 1258:
                                                                               
  file_get_contents(/data/app/my-app-name/composer.json): failed to open stream: No such file or directory

我已经通过 SSH 连接到服务器，并且可以确认 composer.json 文件不存在，但我不知道为什么它不存在。

我已经测试了使用和不使用命令的部署，没有它也可以正常工作 - 成功部署和失败部署之间的唯一区别是添加了一个自定义工匠命令。

如果有用的话，我的命令如下：

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Config;
use File;

class Maintenance extends Command

    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'maintenance:toggle';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Toggles a custom maintenance mode on or off';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    
        parent::__construct();
    

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    
        // Get current config file
        $array = Config::get('maintenance');

        // Toggle 'enabled' value
        $array['enabled'] = !$array['enabled'];

        // Get string representation of array
        $data = var_export($array, 1);

        // Overwrite file - this causes change to persist, unlike Config::set()
        if(File::put(config_path() . '/maintenance.php', "<?php\n return $data ;")) 
            $this->info('Maintenance mode ' . (!$array['enabled'] ? 'enabled' : 'disabled') . '!');

            // Clear and re-cache config
            $this->callSilent('config:cache');
         else 
            $this->error('Failed to modify config value');
        
    

该命令位于我的app/Console/Commands 目录中，我没有更改我的app\Console\Kernel.php 文件，因为Laravel 文档表明Commands 文件夹中的任何命令都将由Kernel.php 使用此行自动导入, $this->load(__DIR__.'/Commands');

提前感谢您的帮助，如果有任何其他有用的信息，请告诉我。

干杯

编辑：

使用以下 gitlab-ci.yml 脚本部署应用：

    - env | grep DOTENV | sed  's/DOTENV_//g' > .env
    - |
      rsync \
        -a -z \
        --include '.env' \
        --include './public/angular' \
        --exclude /.vscode/ \
        --exclude ./angular/ \
        --exclude database/ \
        --exclude docs/ \
        --exclude node_modules/ \
        --exclude /scripts/ \
        --exclude tests/ \
        --exclude '/*.*' \
        ./ \
        $SRV_SSH_USER@$SRV_IP_ADDRESS:$DEPLOY_DIR
    - |
      ssh $SRV_SSH_USER@$SRV_IP_ADDRESS <<EOF
        rm -rf /tmp/$SRV_DEPLOY_DIR
        mv /data/app/$SRV_DEPLOY_DIR /tmp
        chmod 775 -R $DEPLOY_DIR
        chown $SRV_SSH_USER:www-data -R $DEPLOY_DIR
        mv $DEPLOY_DIR /data/app/$SRV_DEPLOY_DIR
        php /data/app/$SRV_DEPLOY_DIR/artisan config:cache
        php /data/app/$SRV_DEPLOY_DIR/artisan view:clear
        php /data/app/$SRV_DEPLOY_DIR/artisan route:clear
        php /data/app/$SRV_DEPLOY_DIR/artisan up
      EOF

我看不出这个脚本是如何导致问题的，因为它适用于没有这个新的工匠命令的部署。

【问题讨论】：

请分享更多细节。你如何运行你的部署？这和 nginx 有什么关系？

可能你忽略了.gitignore中的composer.json？

@SviesusAlus 绝对不是——正如我所说，它适用于所有其他部署，只有当我包含此命令时它才会出现在服务器上

嗨@NicoHaase - 我标记了Nginx，因为我部署到的服务器正在运行Nginx，尽管我承认这不太可能与问题相关。我已经编辑了我的问题以包含部署脚本

【参考方案1】：

所以我设法解决了这个问题。该命令位于App\Console\Commands目录中-我将其重命名为App\Console\Custom_commands，并在App\Console\Kernel.php中手动导入了它，

protected $commands = [
    Maintenance::class
];

如果我将命令存储在另一个目录中，它也可以工作，即我在这里使用的命名不相关（只要它不被称为 Commands）

老实说，我不知道为什么我必须这样做才能让它工作，所以我只是在回答这个问题以防其他人遇到同样的问题。

干杯