Skip to content

Commit 9ada9c8

Browse files
Add TOC and some details (#4)
1 parent 4088110 commit 9ada9c8

1 file changed

Lines changed: 18 additions & 4 deletions

File tree

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,23 @@
22

33
Create Python distribution packages: source, wheel and Debian packages
44

5+
## Table of Contents
6+
7+
- [Features](#features)
8+
- [Inputs](#inputs)
9+
- [Platform independent or native package creation](#platform-independent-or-native-package-creation)
10+
- [Cross-platform package creation](#cross-platform-package-creation)
11+
- [Outputs](#outputs)
12+
- [Usage](#usage)
13+
- [Create Python library packages](#create-python-library-packages)
14+
- [Create Python application packages](#create-python-application-packages)
15+
- [Create cross-platform Python application packages](#create-cross-platform-python-application-packages)
16+
517
## Features
618

719
- Create Python source and wheel packages
8-
- Create Debian packages for Python libraries and applications
20+
- Create Debian packages for Python libraries and applications (supports [FPM](https://fpm.readthedocs.io/en/latest/)
21+
and [dh-virtualenv](https://dh-virtualenv.readthedocs.io/en/latest/) packaging)
922
- Cross-platform package creation using QEMU, Docker buildx and devcontainer
1023

1124
## Inputs
@@ -19,14 +32,16 @@ Create Python distribution packages: source, wheel and Debian packages
1932
- `add-source-dist`: Add source distribution to the package creation (default: `true`)
2033
- `add-wheel-dist`: Add wheel distribution to the package creation (default: `true`)
2134
- `debian-dist-type`: Type of the Debian package to create: `library`/`application`/`none` (default: `none`)
22-
- `debian-dist-command`: Command to run for the Debian package creation (default: FPM build for libraries, dh-virtualenv for applications)
35+
- `debian-dist-command`: Command to run for the Debian package creation (default: FPM build for libraries, dh-virtualenv
36+
for applications)
2337

2438
### Cross-platform package creation
2539

2640
- `docker-registry`: Docker registry to use (default: `docker.io`)
2741
- `docker-username`: Docker registry username
2842
- `docker-password`: Docker registry password
29-
- `devcontainer-config`: Devcontainer configuration selector `.devcontainer/<config>/devcontainer.json` (if not specified, it will use `.devcontainer/devcontainer.json`)
43+
- `devcontainer-config`: Devcontainer configuration selector `.devcontainer/<config>/devcontainer.json` (if not
44+
specified, it will use `.devcontainer/devcontainer.json`)
3045
- `devcontainer-command`: Command to run in the devcontainer
3146

3247
## Outputs
@@ -88,7 +103,6 @@ jobs:
88103
- uses: EffectiveRange/python-package-github-action@v1
89104
with:
90105
is-cross-platform: 'true'
91-
debian-dist-type: 'application'
92106
docker-username: ${{ secrets.DOCKERHUB_USERNAME }}
93107
docker-password: ${{ secrets.DOCKERHUB_TOKEN }}
94108
devcontainer-config: 'arm32v7'

0 commit comments

Comments
 (0)