Method create_dispatch

github/Workflow.py:147–180

:calls: `POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches `_ Note: raises or return False without details on error, depending on the ``throw`` parameter.

(
        self,
        ref: github.Branch.Branch | github.Tag.Tag | github.Commit.Commit | str,
        inputs: Opt[dict] = NotSet,
        throw: bool = False,
    )

    # v3: default throw to True
    def create_dispatch(
        self,
        ref: github.Branch.Branch | github.Tag.Tag | github.Commit.Commit | str,
        inputs: Opt[dict] = NotSet,
        throw: bool = False,
    ) -> bool:
        """
        :calls: `POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches <https://docs.github.com/en/rest/reference/actions#create-a-workflow-dispatch-event>`_
        Note: raises or return False without details on error, depending on the ``throw`` parameter.
        """
        assert (
            isinstance(ref, github.Branch.Branch)
            or isinstance(ref, github.Tag.Tag)
            or isinstance(ref, github.Commit.Commit)
            or isinstance(ref, str)
        ), ref
        assert inputs is NotSet or isinstance(inputs, dict), inputs
        if isinstance(ref, github.Branch.Branch):
            ref = ref.name
        elif isinstance(ref, github.Commit.Commit):
            ref = ref.sha
        elif isinstance(ref, github.Tag.Tag):
            ref = ref.name
        if inputs is NotSet:
            inputs = {}
        url = f"{self.url}/dispatches"
        input = {"ref": ref, "inputs": inputs}

        if throw:
            self._requester.requestJsonAndCheck("POST", url, input=input)
            return True
        else:
            status, _, _ = self._requester.requestJson("POST", url, input=input)
            return status == 204

    def get_runs(
        self,