Update readme for 0.1.0 release

This commit is contained in:
Fizban 2020-06-03 00:50:15 +10:00
parent e5d7a99003
commit eb09f72a9c
2 changed files with 56 additions and 7 deletions

View File

@ -1,2 +1,54 @@
# pyinstaller-action # pyinstaller-action
Github Action for building executables with Pyinstaller
Github Action for building executables with PyInstaller
To build your application, you need to specify where your source code is via the `path` argument, this defaults to `src`.
The source code directory should have your `.spec` file that PyInstaller generates. If you don't have one, you'll need to run PyInstaller once locally to generate it.
If the `src` folder has a `requirements.txt` file, the packages will be installed into the environment before PyInstaller runs.
## Example usage
Include this in your `.github/workflows/main.yaml`:
```yaml
- name: PyInstaller Windows
uses: JackMcKew/pyinstaller-action-windows@master
```
## Full Example
Here is an entire workflow for:
- Packaging an application with PyInstaller
- Uploading the packaged executable as an artifact
``` yaml
name: Package Application with Pyinstaller
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Package Application
uses: JackMcKew/pyinstaller-action-windows@master
with:
path: src
- uses: actions/upload-artifact@v2
with:
name: name-of-artifact
path: src/dist/windows
```

View File

@ -30,17 +30,14 @@ if [[ "$PYPI_URL" != "https://pypi.python.org/" ]] || \
echo "Using custom pip.ini: " echo "Using custom pip.ini: "
cat /wine/drive_c/users/root/pip/pip.ini cat /wine/drive_c/users/root/pip/pip.ini
fi fi
echo "before cd"
ls
cd $WORKDIR cd $WORKDIR
echo "after cd"
ls
if [ -f requirements.txt ]; then if [ -f requirements.txt ]; then
pip install -r requirements.txt pip install -r requirements.txt
fi # [ -f requirements.txt ] fi # [ -f requirements.txt ]
echo "this is at"
echo "$@"
# if [[ "$@" == "" ]]; then # if [[ "$@" == "" ]]; then
pyinstaller --clean -y --dist ./dist/windows --workpath /tmp *.spec pyinstaller --clean -y --dist ./dist/windows --workpath /tmp *.spec