Debian 软件包是否有标准/推荐的目录结构?

时间:2021-04-12 20:23:38

标签: python debian packaging

我的下一个项目将是一个用 Python 编写的 Debian 守护进程,我想将它打包为一个 Debian 原生包。该项目使用 Git 进行版本控制,代码托管在 GitHub 中。

如何组织存储库中的目录和分支?有标准/通用/推荐的方式吗?

项目基本由一些python脚本和systemd单元文件组成。环顾四周,我想出了这个目录结构,但我不知道它是否合理:

my-app/
├── debian/
│   ├── control
│   ├── copyright
│   ├── changelog
│   ├── rules
│   └── ...
├── my_module/
│   ├── __init__.py
│   ├── my_script.py
│   └── ...
├── systemd/
│   ├── my-service.service
│   └── ...
├── README.md
├── LICENSE
└── ...

1 个答案:

答案 0 :(得分:1)

您似乎是在询问目录结构(哪些文件应该在何处),而不是存储库结构(这将是关于分支的)。

结构如下:

  • 上游项目(例如源发布 tarball 的内容)
  • 在此目录的根目录中加上一个 debian/ 文件夹

就是这样。 此结构旨在允许打包任意项目 - 唯一的限制是没有 debian/ 文件夹。

现在,这种结构与将上游开发与 Debian 打包分开的概念非常紧密地结合在一起。 (这可能不适用于您的用例,因为您似乎既是上游开发人员又是创建 Debian 软件包的人)。

为了使最终适应 Debian 更容易(例如,将软件包适应真正的 Debian 发行版),您应该确保 /debian 目录不包含在发行版 tarball 中。< /p>

您还应该从发布 tarball 中排除存储库配置文件(.gitignore 文件、CI 配置...)

如果使用 git,您可能会添加一个 .gitattributes 文件,其中包含(除其他外):

/debian/    export-ignore
.git*       export-ignore

还有一个关于如何成为 Debian 优秀上游的更详尽的在线指南:https://wiki.debian.org/UpstreamGuide