About description of pack.yaml file when creating pack

I am making a pack now.
It seems that “ref: [packname]” must be specified in pack.yaml.
How is this specification used in stackstorm?
Also, can I give it my favorite name?

Also, pack creation document (Create and Contribute a Pack — StackStorm 3.1.0 documentation
) Is written as follows, but capital letters seem to be an error. This may be better added to the document.

# Pack reference.It can only contain letters, digits and underscores.

Error example

  File "/opt/stackstorm/packs/packs/actions/pack_mgmt/setup_virtualenv.py", line 88, in run
    no_download = no_download)
  File "/opt/stackstorm/st2/lib/python2.7/site-packages/st2common/util/virtualenvs.py", line 72, in setup_pack_virtualenv
    raise ValueError ('Invalid pack name "% s"'% (pack_name))
ValueError: Invalid pack name "HMPack"

For simplicity and to avoid confusion, it’s recommended that “ref” and “name” attributes are the same and they shouldn’t contain any special characters.

“ref” contains pack reference which is used when referring actions inside workflows, rules, using
st2 pack install" CLI command, etc. and “name” is a user friendly pack name.

Name can contain arbitrary characters, while “ref” can only contain ^[a-z0-9_]+$ characters.

In your case, that step likely failed, because you used “name” attribute instead of “ref”.

Hi, Tomaz

Thank you for answering.

I understand how to use ref and name. I learned a lot.

In the first place, ref could not use capital letters.

I was saved. Thank you.

You are welcome.

I also opened a PR which clarifies “ref” can only contain lowercase letters - Update pack docs by Kami · Pull Request #947 · StackStorm/st2docs · GitHub.

Next time, feel free to open such PR yourself.


OK. It was helpful because I had never opened PR with git before.

If there is something next, try it.

Thank you for the response.