Skip to content

Commit

Permalink
updated
Browse files Browse the repository at this point in the history
  • Loading branch information
lnxpy committed Nov 18, 2024
1 parent 0ccf2b0 commit b0d7d18
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ PyAction helps you to develop [GitHub Actions](https://docs.github.com/en/action
from pyaction import PyAction


workflow = PyAction.workflow()
workflow = PyAction()

@workflow.action()
def greetings_action(name: str, age: int) -> None:
Expand All @@ -27,11 +27,14 @@ def greetings_action(name: str, age: int) -> None:
)

# $ pyaction run
# ┏━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
# ┃ Variable ┃ Value ┃ Type ┃ Workflow Usage ┃
# ┡━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
# │ phrase │ Hello Jane. You are 20! │ <class 'str'> │ ${{ steps.STEP_ID.outputs.phrase }} │
# └──────────┴─────────────────────────┴───────────────┴─────────────────────────────────────┘
# [
# {
# "var": "phrase",
# "value": "Hello Jane. You are 20!",
# "type": "<class 'str'>",
# "usage": "${{ steps.STEP_ID.outputs.phrase }}"
# }
# ]
```

Check out the [official docs](https://pyaction.imsadra.me) for more detailed information. There is also a [Quickstart](https://pyaction.imsadra.me/quickstart) demo tutorial that walks you through a simple hello-world action.
Expand Down

0 comments on commit b0d7d18

Please sign in to comment.