庖丁解牛/notion-notifier

更新 notion.io 信息的命令

0.1.0 2022-07-17 15:58 UTC

This package is auto-updated.

Last update: 2024-09-17 22:39:47 UTC


README

保持所有项目和它们的版本在控制之下!

Notion-Notifier 是一个小型包,用于将当前版本提交到 notion 页面。

目标是更新使用的框架(symfony、pimcore、laravel、drupal...)以及您的代码库(git 标签)的版本。

该包可以无差别使用或在 Laravel 中使用得更舒适一些。

准备

这个包旨在列出项目,这些项目被收集到一个 notion 数据库中。在数据库中,每个条目都是一个独特的 notion 页面,具有数据库属性。

example table in notion

在这个例子中,我们会有两个列:FW-Version(框架)和CB-Version(代码库),我们希望在每次更新时填充新的实际值。要更新某些内容,我们必须有某些内容,这意味着

  • Notion 账户和项目数据库
  • Notion API 密钥
  • Notion 页面的 ID
  • 页面属性的名称

安装

使用包管理器 composer 安装 notion-notifier。

composer require xanobius/notion-notifier

使用(无差别)

use Xanobius\NotionNotifier\NotionNotifier;

$notifier = new NotionNotifier;
$notifier->setPageId('[YOUR PAGE ID]');
$notifier->setNotionSecret('[YOUR NOTION SECRET]');

try{
    $notifier->updatePageValue('[PROPERTY NAME]', '[NEW VALUE]');
}catch(Exception $e){
    // do your error handling here
}

Laravel 中的使用

安装后,.env 文件等待您的设置

NOTION_SECRET=
NOTION_PAGE_ID=
NOTION_LARAVEL_PROP=
NOTION_GIT_PROP=

设置这些选项后,只需调用命令

php artisan notion-notifier:version

该命令会将代码库和框架版本提交到指定的属性,并在部署后调用。要更改包的行为,可以发布配置并调整以满足您的需求。

sail artisan vendor:publish --provider="Xanobius\NotionNotifier\NotionNotifierServiceProvider" --tag="config"

下一步...

symfony/pimcore 项目的集成,配置也一并考虑。

贡献

欢迎提交拉取请求。对于重大更改,请先提交一个问题来讨论您想要更改的内容。

请确保根据需要更新测试。

许可证

MIT