开源项目 `openwhisk-package-template` 教程

开源项目 openwhisk-package-template 教程

openwhisk-package-template[DEPRECATED] - This is a template to be use when creating new packages for OpenWhisk项目地址:https://gitcode.com/gh_mirrors/op/openwhisk-package-template

本教程将引导您了解如何使用 Apache OpenWhisk 的包模板项目 openwhisk-package-template。

1. 项目目录结构及介绍

openwhisk-package-template 的目录结构如下：

.
├── actions          # 包含动作（action）代码及其相关资源
│   └── helloWorld    # 示例 HelloWorld 动作代码
├── tests             # 测试用例
└── tools             # 辅助工具，如 Travis CI 配置
    ├── .travis.yml    # Travis CI 构建配置文件
├── .gitignore        # Git 忽略文件列表
├── CONTRIBUTING.md   # 贡献指南
├── LICENSE.txt       # 许可证文件
├── README.md         # 项目读我文件
└── install.sh        # 安装脚本
└── uninstall.sh      # 卸载脚本

• actions: 存放包中定义的动作的源代码。
• tests: 包含测试这些动作的脚本。
• tools: 提供自动化构建和测试工具，如持续集成配置文件。
• .gitignore: 列出在版本控制中忽略的文件类型。
• CONTRIBUTING.md: 项目贡献指南，描述了如何参与项目开发。
• LICENSE.txt: 项目许可证信息，此项目遵循 Apache 2.0 许可。
• README.md: 项目概述和基本用法说明。
• install.sh 和 uninstall.sh: 分别用于安装和卸载包到 OpenWhisk 环境的脚本。

2. 项目的启动文件介绍

虽然 openwhisk-package-template 不是标准意义上的“运行时”项目，但它包含两个主要的脚本来管理和操作包：

• install.sh: 这个脚本负责在 OpenWhisk 中创建一个新包并部署其中的动作。要使用它，你需要提供适当的 OpenWhisk CLI 环境，并确保已登录到你的 OpenWhisk 帐户。通过执行 bash install.sh 可以在你的命名空间下创建和部署包。

• uninstall.sh: 当不再需要包时，此脚本可以移除你在 install.sh 中创建的包。同样，确保你有权限执行相应的 OpenWhisk CLI 操作，然后运行 bash uninstall.sh 来删除包。

请注意，这些脚本依赖于本地已经配置好的 OpenWhisk CLI 工具。

3. 项目的配置文件介绍

项目中没有特定的配置文件，但配置可以通过以下方式设置：

• OpenWhisk CLI: 在运行 install.sh 或其他 OpenWhisk 相关命令时，可以使用环境变量或通过 -w（API 主机）和 -k（API 密钥）参数来指定 OpenWhisk 集群的 API 接入点和认证信息。

• Travis CI: .travis.yml 文件用于配置 Travis CI 如何自动构建和测试项目。如果你打算启用持续集成，需要在此文件中设置你的 OpenWhisk 凭证和其他相关环境变量。

要自定义包的行为，你可以修改 actions 目录下的动作源代码。例如，如果你想更改默认的 helloWorld 动作，可以在 helloWorld/index.js 中调整实现逻辑。

使用这个模板作为起点，你可以根据自己的需求定制自己的 OpenWhisk 包，并轻松地将其集成到你的工作流中。记得始终遵守 CONTRIBUTING.md 中的指导，以保持项目的合规性和一致性。

openwhisk-package-template[DEPRECATED] - This is a template to be use when creating new packages for OpenWhisk项目地址:https://gitcode.com/gh_mirrors/op/openwhisk-package-template