https://github.com/jiro4989/build-deb-action
build-deb-action builds a simple debian package.
https://github.com/jiro4989/build-deb-action
debian docker github-actions nim
Last synced: 5 months ago
JSON representation
build-deb-action builds a simple debian package.
- Host: GitHub
- URL: https://github.com/jiro4989/build-deb-action
- Owner: jiro4989
- License: mit
- Created: 2020-07-05T07:37:43.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-05-12T11:00:15.000Z (6 months ago)
- Last Synced: 2025-05-12T11:25:13.730Z (6 months ago)
- Topics: debian, docker, github-actions, nim
- Language: Go
- Homepage:
- Size: 85.9 KB
- Stars: 56
- Watchers: 4
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# build-deb-action
[](https://github.com/jiro4989/build-deb-action/actions?query=workflow%3ATest)
[](https://github.com/jiro4989/build-deb-action/actions?query=workflow%3Areviewdog)
[](https://github.com/jiro4989/build-deb-action/actions?query=workflow%3Arelease)
[](https://github.com/jiro4989/build-deb-action/releases)
[](https://github.com/haya14busa/action-bumpr)
`build-deb-action` builds a simple debian package.
See [build-rpm-action](https://github.com/jiro4989/build-rpm-action) if you want to create `rpm` package.
## Input
```yaml
inputs:
package:
description: 'Package name of debian package.'
required: true
package_root:
description: 'Directory of release files.'
required: true
maintainer:
description: 'Package maintainer name.'
required: true
version:
description: 'Package version.'
required: true
installed_size:
description: 'Package installed size. GitHub Actions set summarized byte size of `package_root` directory when this parameter is empty.'
default: ''
required: false
depends:
description: 'Package dependencies.'
default: ''
required: false
pre_depends:
description: 'Package pre-dependencies.'
default: ''
required: false
homepage:
description: 'Package homepage url.'
default: ''
required: false
section:
description: 'Package section.'
default: ''
required: false
priority:
description: 'Package priority.'
default: ''
required: false
arch:
description: 'Package architecture.'
default: 'amd64'
required: false
desc:
description: 'Package description.'
default: ''
required: false
compress_type:
description: >
Set the compression type used when building.
Allowed types gzip, xz, zstd, none.
Default is gzip.
default: 'gzip'
required: false
keep_ownership:
description: >
If set to true, it creates the package keeping files' owner and group, otherwise they will be assigned to root
Default is false.
default: 'false'
required: false
```
## Output
```yaml
outputs:
file_name:
description: 'File name of resulting .deb file.'
```
## Usage
```yaml
name: build
on:
push:
tags:
- 'v*.*.*'
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: create sample script
run: |
mkdir -p .debpkg/usr/bin
mkdir -p .debpkg/usr/lib/samplescript
echo -e "echo sample" > .debpkg/usr/bin/samplescript
chmod +x .debpkg/usr/bin/samplescript
echo -e "a=1" > .debpkg/usr/lib/samplescript/samplescript.conf
# create DEBIAN directory if you want to add other pre/post scripts
mkdir -p .debpkg/DEBIAN
echo -e "echo postinst" > .debpkg/DEBIAN/postinst
chmod +x .debpkg/DEBIAN/postinst
- uses: jiro4989/build-deb-action@v4
with:
package: samplescript
package_root: .debpkg
maintainer: your_name
version: ${{ github.ref }} # refs/tags/v*.*.*
arch: 'amd64' # optional
depends: 'git, jq' # optional
pre_depends: 'libc6 (>= 2.2.1)' # optional
desc: 'this is sample package.' # optional
homepage: 'https://github.com/jiro4989/build-deb-action' # optional
section: 'unknown' # optional
priority: 'required' # optional
id: build
# Check a created deb file
- name: Check a path of deb file
run: ls ${{ steps.build.outputs.file_name }}
```
## Example projects
*
## Changes
### v3 -> v4
* #54 Migrate Nim to Golang
* `replacetool` was replaced by golang
* Docker base image was changed from ubuntu 22.04 to ubuntu 24.04
* Default value of optional parameters (`depends`, `homepage` and `section`) was changed from `none` to `""` (empty string)
### v2 -> v3
* PR #45 - Makes all files owned by root
* Changed default file owner to `root`. Use `keep_ownership: true` if you want to revert to `v2` behavior.
## Development
### Flow
1. Create a new branch
1. Commit
1. Merge the branch into `develop` branch
1. Push `develop` branch
1. Check passing all tests
1. Create a new pull request
1. Merge the branch into `master` branch
This actions is using a DockerHub image. We must push `docker-v0.0.0` git-tag
to create a new tagged docker image. Published a new tagged docker image, and
change tag of action.yml into `develop` branch, and check passing all tests,
and merge into `master`.
### Release
#### [haya14busa/action-bumpr](https://github.com/haya14busa/action-bumpr)
You can bump version on merging Pull Requests with specific labels (bump:major,bump:minor,bump:patch).
Pushing tag manually by yourself also work.
#### [haya14busa/action-update-semver](https://github.com/haya14busa/action-update-semver)
This action updates major/minor release tags on a tag push. e.g. Update v1 and v1.2 tag when released v1.2.3.
ref:
### Lint - reviewdog integration
This reviewdog action template itself is integrated with reviewdog to run lints
which is useful for Docker container based actions.
Supported linters:
* [reviewdog/action-shellcheck](https://github.com/reviewdog/action-shellcheck)
* [reviewdog/action-hadolint](https://github.com/reviewdog/action-hadolint)
* [reviewdog/action-misspell](https://github.com/reviewdog/action-misspell)