Show All 34 Lines
35	parameters:	35		parameters:
36	directly_list_of_cmds:	36		directly_list_of_cmds:
37	required: true	37		required: true
38	description: shell command(s) to be executed	38		description: shell command(s) to be executed
39	type: list	39		type: list
40	returns: \|	40		returns: \|
41	The stdout of executed shell command, in case of multiple commands, output of the last one is	41		The stdout of executed shell command, in case of multiple commands, output of the last one is
42	returned.	42		returned.
43
44	raises: \|	43		raises: \|
45	* :class:`.TaskotronDirectiveError`: when parameter of shell directive is not a list, if command	44		* :class:`.TaskotronDirectiveError`: when parameter of shell directive is not a list, if command
46	to be executed does not exist or if command returned non-zero returncode (returncode can be	45		to be executed does not exist or if command returned non-zero returncode (returncode can be
47	ignored, see examples).	46		ignored, see examples).
48		47
49	version_added: 0.4.15	48		version_added: 0.4.15
50	"""	49		"""
51		50
Show All 21 Lines		71	- ignorereturn:
73	- docker pull thiswontwork!1!1!!	72		- docker pull thiswontwork!1!1!!
74	- echo 'No prob, continuing'	73		- echo 'No prob, continuing'
75		74
76	You can run a process directly, without shell processing, which means you don't need to worry	75		You can run a process directly, without shell processing, which means you don't need to worry
77	about escaping special characters or e.g. spaces in file names::	76		about escaping special characters or e.g. spaces in file names::
78		77
79	- name: execute command directly, without shell	78		- name: execute command directly, without shell
80	shell:	79		shell:
81	- [echo, "don't worry about code injection"]	80		- [echo, don't worry about code injection]
82	- [rm, a file with # funny & characters]	81		- [rm, a file with * funny & characters]
83	- [mkdir, ${variable_with_unknown_contents}]	82		# the apostrophes are here just to make YAML syntax valid, they don't get passed in
		83		- [mkdir, '${variable_with_potentially_unsafe_contents}']
84		84
85	You can also run bash script::	85		You can also run bash script::
86		86
87	- name: execute bash script	87		- name: execute bash script
88	shell:	88		shell:
89	- bash test.sh	89		- bash test.sh
90	export: test_output	90		export: test_output
91		91
▲ Show 20 Lines • Show All 60 Lines • Show Last 20 Lines

shell directive: better examples in docsClosedPublicActions

Details

Diff Detail

Revision Contents

Diff 2421

libtaskotron/directives/shell_directive.py

shell directive: better examples in docs
ClosedPublic
Actions