Chrome Web Store Upload CLI教程

Chrome Web Store Upload CLI教程

chrome-webstore-uploadUpload Chrome Extensions to the Chrome Web Store项目地址:https://gitcode.com/gh_mirrors/ch/chrome-webstore-upload

项目介绍

Chrome Web Store Upload CLI 是一个命令行工具，由fregante维护，专门用于简化Chrome扩展上传到Chrome Web Store的过程。它支持自动将扩展发布到Web Store，兼容ZIP文件或目录，并通过OAuth2授权进行安全操作。无需复杂的浏览器界面操作，开发者可以方便地通过命令行完成扩展的上传与发布流程。

项目快速启动

在开始之前，确保你的开发环境已准备好Node.js。

安装

首先，通过npm安装此CLI工具：

npm install chrome-webstore-upload-cli -g

配置API凭据

你需要从Google Developers Console获取clientId, clientSecret和生成refreshToken。具体步骤参见官方指南。

使用示例

一旦配置好凭据，你可以通过以下命令上传并发布你的扩展：

chrome-webstore-upload --source path/to/your-extension --client-id <YOUR_CLIENT_ID> --client-secret <YOUR_CLIENT_SECRET> --refresh-token <YOUR_REFRESH_TOKEN>

如果你的项目已经配置了package.json并且包含了webExt字段指定sourceDir，则可以直接运行：

chrome-webstore-upload

应用案例和最佳实践

• 自动化部署流程: 结合GitHub Actions或其他CI/CD平台，可以在每次代码合并到主分支时自动更新扩展。

  示例GitHub Actions配置片段：

  on:
    push:
      branches:
        - main
  jobs:
    deploy-extension:
      runs-on: ubuntu-latest
      steps:
        - uses: actions/checkout@v2
        - name: Upload to Chrome Web Store
          run: |
            chrome-webstore-upload --source dist --client-id ${{ secrets.CHROME_CLIENT_ID }} --client-secret ${{ secrets.CHROME_CLIENT_SECRET }} --refresh-token ${{ secrets.CHROME_REFRESH_TOKEN }}
  

• 版本管理: 利用该工具快速迭代测试版本，便于管理和回滚。

典型生态项目

• GifHub: 提供GitHub上GIF预览的便捷扩展。
• OctoLinker: 改善GitHub上的代码浏览体验，智能链接仓库内的其他文件。
• Refined GitHub: 增强GitHub网站的功能性和可用性。

这些生态项目展示了如何利用类似的CLI工具简化扩展的发布过程，提高开发效率，同时也鼓励社区参与创建更多改善日常开发和上网体验的Chrome扩展。

---

以上内容提供了一个关于Chrome Web Store Upload CLI的基本使用框架，帮助开发者高效地管理自己的Chrome扩展程序，实现自动化发布和管理。通过遵循这些步骤和最佳实践，你可以轻松地将你的创意带给Chrome用户群。

chrome-webstore-uploadUpload Chrome Extensions to the Chrome Web Store项目地址:https://gitcode.com/gh_mirrors/ch/chrome-webstore-upload