# pkl-github-action-step-generator
A simple CLI tool to generate a Pkl definition for a given action
## Usage
The tool supports generating Pkl step definitions from two sources, remote or local.
For local, the command is as follows:
```sh
pkl-github-actions-step-generator from-local <path-to-action.yml> <full-reference-to-action> [-o --output <OUTPUT FILE>] [--pkl-github-actions-bindings] [--pkl-github-actions-bindings-version]
```
`full-reference-to-action` should be in the form you would use to reference the action in a workflow (e.g. `actions/checkout@v4`).
The `--pkl-github-actions-bindings` enables the generation of bindings to [pkl-github-actions](https://github.com/emilymclean/pkl-github-actions). The version flag allows you to specify a version (otherwise a default will be used).
If no output is provided, the file content will instead be output to stdout.
Remote has the same options, except it finds the `action.yml` in the remote repository:
```sh
pkl-github-actions-step-generator from-remote <full-reference-to-action> [-o --output <OUTPUT FILE>] [--pkl-github-actions-bindings] [--pkl-github-actions-bindings-version]
```
For example, to generate a file containing the definition for the checkout action, the command would be:
```sh
pkl-github-actions-step-generator from-remote actions/checkout@v4 -o checkout.pkl
```
Raw data
{
"_id": null,
"home_page": "https://github.com/emilymclean/pkl-github-actions-step-generator",
"name": "pkl-github-actions-step-generator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "cli",
"author": "Emily McLean",
"author_email": "emilymcleandeveloper@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ed/c0/2011b1621e2fa70211ef2b441750c74e17f904168f614fc1aae7a7be05d4/pkl_github_actions_step_generator-0.1.13.tar.gz",
"platform": null,
"description": "# pkl-github-action-step-generator\n\nA simple CLI tool to generate a Pkl definition for a given action\n\n## Usage\nThe tool supports generating Pkl step definitions from two sources, remote or local.\n\nFor local, the command is as follows:\n\n```sh\npkl-github-actions-step-generator from-local <path-to-action.yml> <full-reference-to-action> [-o --output <OUTPUT FILE>] [--pkl-github-actions-bindings] [--pkl-github-actions-bindings-version]\n```\n\n`full-reference-to-action` should be in the form you would use to reference the action in a workflow (e.g. `actions/checkout@v4`).\n\nThe `--pkl-github-actions-bindings` enables the generation of bindings to [pkl-github-actions](https://github.com/emilymclean/pkl-github-actions). The version flag allows you to specify a version (otherwise a default will be used).\n\nIf no output is provided, the file content will instead be output to stdout.\n\nRemote has the same options, except it finds the `action.yml` in the remote repository:\n\n```sh\npkl-github-actions-step-generator from-remote <full-reference-to-action> [-o --output <OUTPUT FILE>] [--pkl-github-actions-bindings] [--pkl-github-actions-bindings-version]\n```\n\nFor example, to generate a file containing the definition for the checkout action, the command would be:\n```sh\npkl-github-actions-step-generator from-remote actions/checkout@v4 -o checkout.pkl\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple CLI tool to generate a Pkl definition for a given action",
"version": "0.1.13",
"project_urls": {
"Homepage": "https://github.com/emilymclean/pkl-github-actions-step-generator"
},
"split_keywords": [
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b6f86d7f15404e26c2aca37589d3d1033ab182ec2d52a7417851e34467579dae",
"md5": "1b348f3e3544accf5fd3498edd59d8d9",
"sha256": "44af00eea437c2ee9ce52bef7607186bbd8d74371042fe8ea3dcc2d4e40a3a6e"
},
"downloads": -1,
"filename": "pkl_github_actions_step_generator-0.1.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1b348f3e3544accf5fd3498edd59d8d9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 11565,
"upload_time": "2024-11-14T04:46:18",
"upload_time_iso_8601": "2024-11-14T04:46:18.545091Z",
"url": "https://files.pythonhosted.org/packages/b6/f8/6d7f15404e26c2aca37589d3d1033ab182ec2d52a7417851e34467579dae/pkl_github_actions_step_generator-0.1.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "edc02011b1621e2fa70211ef2b441750c74e17f904168f614fc1aae7a7be05d4",
"md5": "53622841ea93fb503ab3195532eb789b",
"sha256": "c8552a9053025ba5516423b20e3c52d04743b4a4bd803a4ef18584d28e5fc7b6"
},
"downloads": -1,
"filename": "pkl_github_actions_step_generator-0.1.13.tar.gz",
"has_sig": false,
"md5_digest": "53622841ea93fb503ab3195532eb789b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 9029,
"upload_time": "2024-11-14T04:46:20",
"upload_time_iso_8601": "2024-11-14T04:46:20.084950Z",
"url": "https://files.pythonhosted.org/packages/ed/c0/2011b1621e2fa70211ef2b441750c74e17f904168f614fc1aae7a7be05d4/pkl_github_actions_step_generator-0.1.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-14 04:46:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "emilymclean",
"github_project": "pkl-github-actions-step-generator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pkl-github-actions-step-generator"
}
JSON
