OpenFn / OpenFn/lightning

Provide default/primary action on "Run"

Open
#4,152 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Elixir
Stars
296
Forks
86
Avg merge
1d 13h
Merged PRs (30d)
50

Description

  • Users: "This workflow is beautiful! How do I run it?"
  • OpenFn: "Yeah no worries... click the ▷ Run button, then pick what input to use with the run you're about to create (we'll default that to a sensible option but still want you to verify) and then when you're happy with the input dataclip, click the other ▶ Run button. Note that the second time you have to click ▶ Run the little triangle "play" icon is filled in. This is the international standard for 'no no this time it will actually run trust me.' Understood?
  • Users: 😵‍💫

Ok... so flexibility is WONDERFUL, but we should consider removing a step here if 80% of users want to run with the default input 80% of the time.

What we know:

Right now we have two types of "Run" buttons:

  1. The ▷ Run button in the top menu opens the "create new run with 1 of 3 inputs" panel/dialog.
  2. The ▶ Run button actually executes a run with the chose input (which defaults to empty for webhook triggered workflows, to next_cron_state for cron-triggered workflows, and current_step.input_dataclip when a step/run is loaded.)

Feedback we've gathered:

  1. It's confusing to see a button called "Run" which doesn't actually run.
  2. Most users want to run with the default input anyway.
  3. Users who want to run with a custom input or existing input are advanced users with more knowledge of the app and are cool using a split-button/alt-button.

Proposed solution:

When you click the run, button... it runs.
(And if you want the alternate, you click the dropdown.)

Image
  1. Use the split button
  2. Make the primary action (cmd-enter) a shortcut to "actually create new run with default input"
  3. Make the second action (cmd-shift-enter) a shortcut to "open the 'create new run with 1 of 3 inputs' panel/dialog".

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the existing top-menu Run button, the create-new-run input panel, and the current cmd-enter and cmd-shift-enter shortcuts. Confirm how each workflow trigger selects its default input. Done means the primary split-button action runs with that default, while the alternate action opens the input-selection panel and both shortcuts match the proposed behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.