Skip to content

m github actions

Create the actions metadata as described by given python script.

When creating actions we need to have the python_file be at the root of a python project. This is because when we run the action we will set the path to the directory containing the file.

By default it has been set to src/actions.py since this is a common case for python projects.

The actions.py can be name anything but it must contain a variable named actions. This variable must be an instance or list of m.github.actions.Action.

Source code in m/cli/commands/github/actions.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class Arguments(BaseModel):
    """Create the actions metadata as described by given python script.

    When creating actions we need to have the `python_file` be at the root
    of a python project. This is because when we run the action we will set
    the path to the directory containing the file.

    By default it has been set to `src/actions.py` since this is a common case
    for python projects.

    The `actions.py` can be name anything but it must contain a variable named
    `actions`. This variable must be an instance or list of
    [m.github.actions.Action][].
    """

    python_file: str = Arg(
        default='src/actions.py',
        help='Python script containing the `actions` variable.',
        positional=True,
        validator=validate_file_exists,
    )

    check: bool = Arg(
        default=False,
        help='Check if generated files are up to date and skip writing them.',
    )

    show_traceback: bool = Arg(
        default=False,
        help='Display traceback information in case of an error.',
    )

Options

--check

  • default: false

Check if generated files are up to date and skip writing them.

--show-traceback

  • default: false

Display traceback information in case of an error.

Positional arguments

python_file

  • default: 'src/actions.py'

Python script containing the actions variable.