Document-level options "category"

[ruzickap]

Hello

The new feature introduced in https://github.com/stateful/runme/issues/369 - 'Document-level options "category"' doesn't work:

Example - let's have the following file:

• install-manual-solution-2.md

  ---
  shell: bash
  cwd: /tmp
  category: solution-2
  ---

Installation steps for Solution 2:

echo "[1] Install command in $PWD"

echo "[2] Install second command"

echo "Delete solution"

echo "Delete solution - second command"

• Issue 1 - If I run runme run --all --skip-prompts --category solution-2 --dry-run I got only first command in markdown document "processed":

  #!/opt/homebrew/bin/bash
  
  // run in "/tmp"
  
  set -e -o pipefail
  echo "[1] Install command in $PWD"

  -> Second command [2] Install second command is skipped / ignored ???

• Issue 2 - The runme run --all --skip-prompts --category delete-solution --dry-run is not working at all and delete-solution category is not "recognized":

  could not execute command: No tasks to execute with the category provided

It seems like the feature is buggy.

Thank you for looking at it...

[sourishkrout]

Could you please verify/repro @pastuxso when you get a chance? Thanks.

[pastuxso]

Hi @ruzickap, Thank you for reporting this issue. I'll review it and get back to you as soon as I have news.

[pastuxso]

Hey @ruzickap, I've identified the cause of the issue and I'll fix it. In the meantime, you can use a workaround by adding a name to the cells you want to include in the global category and removing them from the cell with the category. Here's an example:

---
shell: bash
cwd: /tmp
category: solution-2
---

Installation steps for Solution 2:

```sh {"name":"one"}
echo "[1] Install command in $PWD"

echo "[2] Install second command"

echo "Delete solution"

echo "Delete solution - second command"

Output:

![image](https://github.com/stateful/runme/assets/43882/0804effa-8287-436e-a28c-e885f5883626)

As you mentioned, the **--dry-run** argument only takes the first command. I'll work on it, too.

[sourishkrout]

@ruzickap apologies for the named vs unnamed oversight. We fixed the issue and added more test coverage. Thanks @pastuxso! This is going out with the next patch release in the next 24-48h.

[pastuxso]

@sourishkrout, that's excellent news. @ruzickap, I really appreciate your contribution and your patience on this.

[sourishkrout]

v3.3.3 should be going into homebrew momentarily as soon as https://github.com/Homebrew/homebrew-core/pull/173683 is merged.

[ruzickap]

Thank you @pastuxso.

It seems like 'Document-level option "category"' is working fine :-)

As you mentioned above the --dry-run is showing only the first command:

❯ runme run --all --skip-prompts --category solution-2 --dry-run
#!/opt/homebrew/bin/bash

// run in "/tmp"

set -e -o pipefail
echo "[1] Install command in $PWD"

Let me create new issue for that to properly track it...

Thank you...

[sourishkrout]

Thanks @ruzickap! We will keep you posted on #606 accordingly.