cache-apt-pkgs-action

此 Action 允许缓存高级包工具（APT）的包依赖项，以提高工作流执行时间，而不是在每次运行时安装这些包。

[!重要] 正在寻找共同维护者来帮助审查更改并调查问题。我最近没有太多时间来关注这个 Action，但我希望确保它对社区来说仍然是响应及时且可靠的。如果你有兴趣，请联系我。

文档

这个 Action 是 actions/cache 和 apt 工具的组合。某些 Action 需要安装额外的基于 APT 的包才能执行其他步骤。虽然可以在运行时安装包，但这可能会消耗大量的工作流执行时间。

使用方法

前提条件

在你的仓库的 .github/workflows 目录中创建一个工作流 .yml 文件。下面提供了一个示例工作流。有关更多信息，请参考 GitHub 帮助文档中的创建工作流文件。

版本

你可以使用三种版本标签。

• @latest - 这将给你最新的发布版本。
• @v# - 仅主版本号将给你该主版本的最新发布版本（例如 v1）。
• 分支
  • @master - 最新的手动和自动测试过的代码。由于是预发布版本，可能不稳定。
  • @staging - 最新的自动测试过的代码，有时可能包含实验性功能。从稳定的开发代码中提取。
  • @dev - 非常不稳定，包含实验性功能。自动测试可能无法显示破坏，因为 CI 也会根据开发中的代码更新。

输入

• packages - 要安装的包的空格分隔列表。
• version - 要加载的缓存版本。每个版本将有自己的缓存。注意，除空格外，允许使用所有字符。
• execute_install_scripts - 恢复时执行 Debian 包的预安装和后安装脚本。更多信息请参见注意事项 / 非文件依赖。

输出

• cache-hit - 一个布尔值，表示是否找到了请求的包的缓存。
• package-version-list - 安装的主要请求包及其版本。表示为以逗号分隔的列表，包版本用等号分隔（即 <包1>=<版本1>,<包2>=<版本2>,...）。
• all-package-version-list - 安装的所有包（包括依赖项）及其版本。表示为以逗号分隔的列表，包版本用等号分隔（即 <包1>=<版本1>,<包2>=<版本2>,...）。

缓存范围

缓存的范围限定于给定的包和分支。默认分支的缓存对其他分支可用。

示例工作流

这是创建此 Action 的一个激励用例。

name: 创建文档
on: push
jobs:
  build_and_deploy_docs:
    runs-on: ubuntu-latest
    name: 构建 Doxygen 文档并部署
    steps:
      - uses: actions/checkout@v2
      - uses: awalsh128/cache-apt-pkgs-action@latest
        with:
          packages: dia doxygen doxygen-doc doxygen-gui doxygen-latex graphviz mscgen
          version: 1.0

      - name: 构建
        run: |
          cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}      
          cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}

      - name: 部署
        uses: JamesIves/github-pages-deploy-action@4.1.5
        with:
          branch: gh-pages
          folder: ${{github.workspace}}/build/website

---
install_doxygen_deps:
  runs-on: ubuntu-latest
  steps:
    - uses: actions/checkout@v2
    - uses: awalsh128/cache-apt-pkgs-action@latest
      with:
        packages: dia doxygen doxygen-doc doxygen-gui doxygen-latex graphviz mscgen
        version: 1.0

注意事项

非文件依赖

此 Action 基于大多数包可以作为文件集缓存的原则。但在某些情况下，这是不够的。

• 需要从 /var/lib/dpkg/info/{包名}.[preinst, postinst] 运行预安装和后安装脚本。
• 需要查询 Debian 包数据库以获取上述脚本（即 dpkg-query）。

可以使用 execute_install_scripts 参数尝试执行安装脚本，但不能保证解决问题。

- uses: awalsh128/cache-apt-pkgs-action@latest
  with:
    packages: mypackage
    version: 1.0
    execute_install_scripts: true

如果这无法解决你的问题，你需要为该特定包单独运行 apt-get install 作为一个单独的步骤。

run: apt-get install mypackage
shell: bash

如果你找到了适用于你的场景的解决方法，并且可以推广，请联系我们。这个 Action 能做的只有这么多，不能涉及反向工程 Debian 包管理器的领域。这超出了此 Action 的范围，可能会导致大量的扩展支持和脆弱性。在这种情况下，最好直接为 Debian 包管理器做贡献。

有关更多背景和信息，请参见 issue #57，其中包含了调查和结论。

缓存限制

一个仓库最多可以有 5GB 的缓存。一旦达到 5GB 限制，将根据缓存最后访问的时间淘汰较旧的缓存。一周内未访问的缓存也将被淘汰。要获取有关如何访问和管理 Action 缓存的更多信息，请参见 GitHub Actions / 使用工作流 / 缓存依赖项。