Skip to content

Command to create new actions easily (scaffolding/templating) #103

@davidferlay

Description

@davidferlay

Observed

  • Creating a new action can be a bit tedious: there are many possibilities and features available: args, options, defaults values, processors, runtime, etc
  • Remembering each feature and the corresponding syntax can be hard on user
  • User have to refer on examples from this repo and may resort to copy/pasting existing actions

Expected

  • It could be useful to add a command to help user generate the basic structure / skeleton of a new action, using scaffolding and templating mechanisms
  • It could take inputs (user prompts if tty available or options) such as:
    • name
    • type (local or plugin)
    • path
    • runtime (depending on type)
  • and generate the directories and files with basic content to be further edited by user
  • It could include some basic validation like: path or id of action is available
  • it could be limited to local actions for now and add plugin actions scaffolding in a second time
  • Ideally, content to populate generated action.yaml file could be dynamic based on existing schemas, field types (for args and options) and processors (keyring and config) to prevent excessive effort to maintain scaffolding command as new features are added to launchrctl
  • this new command should live in https://github.com/launchrctl/scaffold as a plugin

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions