andrelohmann.wkhtmltopdf

概述版本洞察

wkhtmltopdf

内容

使用此角色安装 wkhtmltopdf 控制台 PDF 生成器，以及完整的 Google 字体集，以便在生成的 PDF 文档中使用。

wkhtmltopdf 从 Ubuntu 发行版源安装。

需求

此角色需要 Ubuntu。

角色变量

默认变量集可用于决定是否需要安装完整的 Google 字体集

wkhtmltopdf_install_google_fonts: true

可以从这里提取实际的标签版本 here。

示例剧本

- hosts: wkhtmltopdf
  roles:
     - { role: andrelohmann.wkhtmltopdf }

角色开发

特殊目的

此库支持以下功能以便角色开发：

yamllint
ansible-lint
molecule 测试
GitHub Actions
自动版本更新
更新 ansible-galaxy
显示构建状态
在 Vagrant 中测试（用于开发目的）
使用 molecule 测试（在 Vagrant 内或外）
在 Docker 容器中测试
在 vscode 中测试和开发

先决条件

https://thedatabaseme.de/2022/01/17/automated-testing-your-ansible-role-with-molecule-and-github-actions/

安装了 Virtualbox + Vagrant（仅在需要使用 Vagrant 测试角色时才必要）
Docker Desktop
Visual Studio Code + 远程扩展包（依赖已在 .vscode/extensions.json 中定义）

开发设置

此 ansible 角色使用 molecule 进行测试开发。其开发基于 Visual Studio Code 和相关的开发容器，解决必要工具（ansible、linter、molecule）的所有依赖关系。

该角色将在 Ubuntu jammy 上测试。

要从开发容器内启动 molecule 测试容器，需要将 Docker 套接字绑定挂载到开发容器中。

重要文件和文件夹

.devcontainer

定义开发容器的 Dockerfile
配置开发容器启动（例如，绑定挂载 Docker 套接字）

molecule/default/Dockerfile.js

用作 molecule/default/molecule.yml 中定义的所有平台的模板
准备支持 systemd 服务的环境（对于某些基于 systemd 的 ansible 角色是必要的）
安装运行 ansible 所需的所有依赖
文件的内容与 molecule/default/molecule.yml 中平台的属性一致
有关更多信息 - 研究 molecule 文档

使用

Visual Studio Code

code .

在开发容器中，您可以使用以下运行命令：

yamllint .
ansible-lint .
molecule create
molecule test

Vagrant + Virtualbox

切换到角色的根目录
切换到 vagrant 文件夹
启动并进入 vagrant 机器

vagrant up
vagrant ssh

切换到角色文件夹

cd /etc/ansible/roles/ansible-role- [tab]

现在您可以运行所有测试

yamllint .
ansible-lint .
molecule create
molecule test

构建和发布过程

ansible 角色定义了一系列 GitHub 工作流，用于运行 molecule 测试和发布管理。

发布管理需要一些设置。

保护主分支

设置 -> 分支 -> 添加分支保护规则
分支模式名称 -> main 或 master（根据您的默认分支）
保护匹配的分支 -> 勾选“合并前需要拉取请求”
“需要审核”可根据需要单独处理

授予 GITHUB_TOKEN 读写权限

设置 -> Actions -> 常规 -> 工作流权限 -> 读和写权限

提交信息

提交信息应遵循特定格式以实现补丁、小版本或大版本的语义版本更新。

补丁

0.0.x

fix(single_word): 描述

小版本

0.x.0

feat(single_word): 描述

大版本

x.0.0

perf(single_word): 描述
BREAKING CHANGE: 描述破坏性变更

特别重要的是，在第二行及以后的行中提到“BREAKING CHANGE: ”。在单行提交信息中，将忽略大版本更新。

添加 GALAXY_API_KEY 密钥

在 https://galaxy.ansible.com/ 上使用您的 GitHub 账户进行身份验证。
从偏好设置 -> API 密钥中获取 galaxy API 密钥
打开您的 GitHub 角色库
设置 -> 密钥和变量 -> 操作 -> 新建库密钥
使用 “GALAXY_API_KEY” 作为键，复制的 galaxy API 密钥作为值

许可证

MIT

作者信息

https://github.com/andrelohmann

维护者联系

André Lohmann <lohmann.andre (at) gmail (dot) com>

关于项目

ansible galaxy role to install wkhtmltopdf client generator

role wkhtml

安装

ansible-galaxy install andrelohmann.wkhtmltopdf

GitHub 仓库

0 星标

0 分叉

1 未解决问题

许可证

mit

下载

11.9k

拥有者

Andre Lohmann