adamgaskins/deployed

一个用于Laravel应用程序发送漂亮的Slack部署通知的包。

资助包维护!
AdamGaskins

v1.1.0 2022-06-07 20:04 UTC

This package is auto-updated.

Last update: 2024-09-08 01:08:18 UTC


README

一个针对Laravel应用程序的有意见的部署通知生成器。

GitHub license

安装

您可以通过Composer安装此包

composer require adamgaskins/deployed

您应该发布配置文件,以便您可以自定义通知中发送的按钮

php artisan vendor:publish --provider="AdamGaskins\Deployed\DeployedServiceProvider" --tag="deployed-config"

以下为已发布的配置文件内容。您至少需要更新Changelog路径中的vendor/app以指向您的应用程序,并确保已上传白色透明的logo PNG。

return [
    'links' => [
        'Changelog' => 'https://github.com/vendor/app/blob/v{appVersion}/CHANGELOG.md',
        'Visit Site' => '{appUrl}',
    ],

    'logo' => public_path('img/logo.png'),

    'slack' => [
        'webhook' => env('DEPLOYED_SLACK_WEBHOOK')
    ],

    'default_emoji' => '',

    'emojis' => [
        'feature' => '',
        'bug' => '🐛',
        'docs' => '📝',
        'tests' => ''
    ]
];

您还需要在config/app.php文件中添加一个version字段。这是Deployed获取版本号的方式。

[
    'name' => env('APP_NAME'),
    
    'version' => '1.0.0'
]

最后,将Slack webhook添加到.env文件

DEPLOYED_SLACK_WEBHOOK=https://hooks.slack.com/services/xxx/xxx/xxx

用法

在部署成功后运行此命令,以发送带有变更日志的漂亮的Slack通知。

php artisan deployed --notify

Deployed将解析应用程序根目录下的CHANGELOG.md。每个版本都期望以标题开始,并包含更改列表。对于列表中的每个更改,请将类型(功能/错误等)在行的开头加粗。以下是readme顶部的通知生成示例的变更日志条目

### Version 10.3.23
> Released 09/10/2021

- **FEATURE:** Added **Duplicate** button to product editor.
- **BUG:** Deleting a product with no image but with image dimensions specified causes an error.
- **DOCS:** Updated `README.md` to document new deployment steps.
- **TESTS:** Added tests for new **Duplicate** button.

...

测试

composer test

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件