├── entrypoint.sh ├── README.md ├── Dockerfile └── LICENSE /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | set -e 3 | sh -c "black $*" 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Black Code Formatter GitHub Action 2 | 3 | A GitHub action that runs [black code formatter](https://github.com/ambv/black) for Python. 4 | 5 | ## Example Workflow 6 | 7 | ```workflow 8 | workflow "Example Workflow" { 9 | on = "push" 10 | resolves = ["Lint"] 11 | } 12 | 13 | action "Lint" { 14 | uses = "lgeiger/black-action@master" 15 | args = ". --check" 16 | } 17 | ``` 18 | 19 | For a full list of possible `args` checkout the [black docs](https://github.com/ambv/black#command-line-options). 20 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3 2 | 3 | LABEL "com.github.actions.name"="Black Code Formatter" 4 | LABEL "com.github.actions.description"="Format Python code using black" 5 | LABEL "com.github.actions.icon"="code" 6 | LABEL "com.github.actions.color"="yellow" 7 | 8 | LABEL "repository"="https://github.com/lgeiger/black-action" 9 | LABEL "homepage"="https://github.com/lgeiger/black-action" 10 | LABEL "maintainer"="Lukas Geiger " 11 | 12 | RUN pip install black 13 | 14 | COPY entrypoint.sh /entrypoint.sh 15 | 16 | ENTRYPOINT ["/entrypoint.sh"] 17 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2019 Lukas Geiger 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | --------------------------------------------------------------------------------