Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Update README.md and print version used #1

Merged
merged 1 commit into from
Jul 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 23 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,29 @@

A GitHub action that runs [black code formatter](https://github.com/ambv/black) for Python.

## Example Workflow

```workflow
workflow "Example Workflow" {
on = "push"
resolves = ["Lint"]
}

action "Lint" {
uses = "lgeiger/black-action@master"
args = ". --check"
}
## Example action

```
name: Build

on: [push]

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v1
with:
lfs: false
- name: Black Code Formatter
uses: tripactions/[email protected]
with:
args: ". --check -l 100 -t py37"

```

For a full list of possible `args` checkout the [black docs](https://github.com/ambv/black#command-line-options).

Based on the original [lgeiger/black-action](https://github.com/lgeiger/black-action).
1 change: 1 addition & 0 deletions entrypoint.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/bin/sh
set -e
sh -c "black --version"
sh -c "black $*"