Actions (#872)

[lexor]

• Artifacts
• Secrets
• Self-hosted runners
• Workflows
• Workflow jobs
• Workflow runs

Documentation: https://developer.github.com/v3/actions/

[acrobat]

Thanks for working on this @lexor! Let me know when it's ready for review 🚢

[fodinabor]

What's missing from the developer.github.com documentation is e.g. dispatching:
https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#create-a-workflow-dispatch-event

I've been successful with:

    /**
     * @link https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#create-a-workflow-dispatch-event
     *
     * @param string $username
     * @param string $repository
     * @param string $workflowId
     * @param string $ref
     * @param array  $inputs
     *
     * @return array|string
     */
    public function dispatches(string $username, string $repository, string $workflowId, string $ref, array $inputs = [])
    {
        $parameters = array('ref' => $ref, 'inputs' => $inputs);
        return $this->post('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/actions/workflows/'.rawurlencode($workflowId).'/dispatches', $parameters);
    }

Another note: workflowId is in most cases allowed to contain the filename of the workflow, so string should be preferred over int

[lexor]

What's missing from the developer.github.com documentation is e.g. dispatching:
docs.github.com/en/free-pro-team@latest/rest/reference/actions#create-a-workflow-dispatch-event

Thanks for sharing the dispatches function, but this pull request based on this documentation. After this pull request I can work on this documentation.

I'm not add organization endpoints (self-hosted runners) because marked on documentation. Organization endpoints currently in public beta and can be change.

Another note: workflowId is in most cases allowed to contain the filename of the workflow, so string should be preferred over int

I think it can be changed from workflowId to workflow.

[lexor]

Hey @acrobat. This pull request awaiting review.

[fodinabor]

For Get a workflow for example the docs write:

Gets a specific workflow. You can also replace :workflow_id with :workflow_file_name. For example, you could use main.yml.

So, yeah I guess a string parameter named just workflow would make sense here.

[acrobat]

@fodinabor the repo dispatch api endpoint is already added in #931

@lexor A general remark before I do a full review, can you update the doc links to directly link to the new documentation? Example: https://docs.github.com/en/free-pro-team@latest/rest/reference/actions

[lexor]

@lexor A general remark before I do a full review, can you update the doc links to directly link to the new documentation? Example: docs.github.com/en/free-pro-team@latest/rest/reference/actions

Done, I updated 👍

[acrobat]

This comment is also applicable to all occurences of non-query parameters

Can you replace the non url parameters with a array $params/parameters , so our code isn't fixed on a certain set of parameters of github decides to add new options.

Can you also add a docs entry for the added endpoints? The rest of PR looks good 👌

[lexor]

Can you replace the non url parameters with a array $params/parameters , so our code isn't fixed on a certain set of parameters of github decides to add new options.

Sure, replaced. Now non url parameters moved on array $parameters.

Can you also add a docs entry for the added endpoints? The rest of PR looks good 👌

I updated functions and test cases. Also added docs for added endpoints.

[acrobat]

Thanks @lexor! And congrats on your first contribution! 🎉

[dereuromark]

What I am missing is the enable of a specific workflow
See https://docs.github.com/en/rest/reference/actions#enable-a-workflow

[lexor]

What I am missing is the enable of a specific workflow
See docs.github.com/en/rest/reference/actions#enable-a-workflow

Looks like endpoint was added or I missed it. I can create pull request for enable/disable endpoints.

[dereuromark]

Yeah, might be new.
But I also struggle finding the right syntax.
The docs say this should work:

$url = 'repos/' . rawurlencode($organization) . '/' . rawurlencode($repository) . '/actions/workflows/' . (string)$id . '/enable';

$this->post($url);

But it returns Not Found
I made sure to use a token that has permissions for "Workflows".

The dispatches() example above works, which makes this even weirder.