StackStorm / StackStorm/st2

Use consistent names for st2.conf config section groups

Open
#3,526 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Right now we use _ in some places and in others we don't.

I propose that going forward, we should update all the group names to use _ so it's consistent and easier to read.

Having said that, this change will of course also first need to be fully backward compatible (support both approaches) and eventually we can deprecate and remove old notation.

Related https://github.com/StackStorm/st2/pull/3505

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 by reviewing how st2.conf section groups are parsed and compare the inconsistent names described in the issue. Read the related pull request #3505 for context and identify the affected configuration groups. Done means both naming styles remain backward compatible while new group names consistently use underscores, with any deprecation plan documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
devops
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.