StackStorm / StackStorm/st2

Process config attributes / options in the order defined in the config schema when using "pack config" CLI command

Open
#3,053 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

CLI complexity:medium enhancement
Dominant language
Python
Stars
6.5k
Forks
787
PR merge metrics
No merged PRs in 30d

Description

Right now attributes are not processed / displayed in the order defined in the config schema when using st2 pack config command. This could be a bit confusing to the user.

This ties into the age old "preserve ordering when reading and writing out YAML files" issue.

This is not a big blocker for now, but something we should fix in the future to provide a better user experience.

Contributor guide

Open the contributing guide

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 at the st2 pack config CLI command and trace how the config schema and YAML data are read before attributes are processed or displayed. The work is done when attributes consistently follow the order defined in the config schema while preserving the relevant YAML ordering behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.