6b42c2b8c9
To run the formatter on Jupyter Notebooks, Black must be installed with an extra dependency (`black[jupyter]`). This commit adds an optional argument to install Black with this dependency when using the official GitHub Action [1]. To enable the formatter on Jupyter Notebooks, just add `jupyter: true` as an argument. Feature requested at [2]. [1]: https://black.readthedocs.io/en/stable/integrations/github_actions.html [2]: https://github.com/psf/black/issues/3280 Signed-off-by: Antonio Ossa Guerra <aaossa@uc.cl>
51 lines
1.5 KiB
YAML
51 lines
1.5 KiB
YAML
name: "Black"
|
|
description: "The uncompromising Python code formatter."
|
|
author: "Łukasz Langa and contributors to Black"
|
|
inputs:
|
|
options:
|
|
description:
|
|
"Options passed to Black. Use `black --help` to see available options. Default:
|
|
'--check --diff'"
|
|
required: false
|
|
default: "--check --diff"
|
|
src:
|
|
description: "Source to run Black. Default: '.'"
|
|
required: false
|
|
default: "."
|
|
jupyter:
|
|
description:
|
|
"Set this option to true to include Jupyter Notebook files. Default: false"
|
|
required: false
|
|
default: false
|
|
black_args:
|
|
description: "[DEPRECATED] Black input arguments."
|
|
required: false
|
|
default: ""
|
|
deprecationMessage:
|
|
"Input `with.black_args` is deprecated. Use `with.options` and `with.src` instead."
|
|
version:
|
|
description: 'Python Version specifier (PEP440) - e.g. "21.5b1"'
|
|
required: false
|
|
default: ""
|
|
branding:
|
|
color: "black"
|
|
icon: "check-circle"
|
|
runs:
|
|
using: composite
|
|
steps:
|
|
- run: |
|
|
if [ "$RUNNER_OS" == "Windows" ]; then
|
|
python $GITHUB_ACTION_PATH/action/main.py
|
|
else
|
|
python3 $GITHUB_ACTION_PATH/action/main.py
|
|
fi
|
|
env:
|
|
# TODO: Remove once https://github.com/actions/runner/issues/665 is fixed.
|
|
INPUT_OPTIONS: ${{ inputs.options }}
|
|
INPUT_SRC: ${{ inputs.src }}
|
|
INPUT_JUPYTER: ${{ inputs.jupyter }}
|
|
INPUT_BLACK_ARGS: ${{ inputs.black_args }}
|
|
INPUT_VERSION: ${{ inputs.version }}
|
|
pythonioencoding: utf-8
|
|
shell: bash
|