Skip to content

Update new GitHub doc links in repo. #974

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions doc/organization/actions/secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@

### List organization secrets

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#list-organization-secrets
https://docs.github.com/en/rest/reference/actions#list-organization-secrets

```php
$secrets = $client->organization()->secrets()->all('KnpLabs');
```

### Get an organization secret

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#get-an-organization-secret
https://docs.github.com/en/rest/reference/actions#get-an-organization-secret

```php
$secret = $client->organization()->secrets()->show('KnpLabs', $secretName);
```

### Create an organization secret

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#create-or-update-an-organization-secret
https://docs.github.com/en/rest/reference/actions#create-or-update-an-organization-secret

```php
$client->organization()->secrets()->create('KnpLabs', $secretName, [
Expand All @@ -31,7 +31,7 @@ $client->organization()->secrets()->create('KnpLabs', $secretName, [

### Update an organization secret

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#create-or-update-an-organization-secret
https://docs.github.com/en/rest/reference/actions#create-or-update-an-organization-secret

```php
$client->organization()->secrets()->update('KnpLabs', $secretName, [
Expand All @@ -43,23 +43,23 @@ $client->organization()->secrets()->update('KnpLabs', $secretName, [

### Delete an organization secret

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#delete-an-organization-secret
https://docs.github.com/en/rest/reference/actions#delete-an-organization-secret

```php
$client->organization()->secrets()->remove('KnpLabs', $secretName);
```

### List selected repositories for organization secret

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret
https://docs.github.com/en/rest/reference/actions#list-selected-repositories-for-an-organization-secret

```php
$client->organization()->secrets()->selectedRepositories('KnpLabs', $secretName);
```

### Set selected repositories for an organization secret

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret
https://docs.github.com/en/rest/reference/actions#set-selected-repositories-for-an-organization-secret

```php
$client->organization()->secrets()->setSelectedRepositories('KnpLabs', 'secretName', [
Expand All @@ -69,15 +69,15 @@ $client->organization()->secrets()->setSelectedRepositories('KnpLabs', 'secretNa

### Remove selected repository from an organization secret

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret
https://docs.github.com/en/rest/reference/actions#remove-selected-repository-from-an-organization-secret

```php
$client->organization()->secrets()->addSecret('KnpLabs', $repositoryId, $secretName);
```

### Get an organization public key

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#get-an-organization-public-key
https://docs.github.com/en/rest/reference/actions#get-an-organization-public-key

```php
$client->organization()->secrets()->publicKey('KnpLabs');
Expand Down
10 changes: 5 additions & 5 deletions doc/repo/actions/artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,31 @@

### List artifacts for a repository

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#list-artifacts-for-a-repository
https://docs.github.com/en/rest/reference/actions#list-artifacts-for-a-repository

```php
$artifacts = $client->api('repo')->artifacts()->all('KnpLabs');
```

### List workflow run artifacts

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#list-workflow-run-artifacts
https://docs.github.com/en/rest/reference/actions#list-workflow-run-artifacts

```php
$runArtifacts = $client->api('repo')->artifacts()->runArtifacts('KnpLabs', 'php-github-api', $runId);
```

### Get an artifact

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#get-an-artifact
https://docs.github.com/en/rest/reference/actions#get-an-artifact

```php
$artifact = $client->api('repo')->artifacts()->show('KnpLabs', 'php-github-api', $artifactId);
```

### Delete an artifact

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#delete-an-artifact
https://docs.github.com/en/rest/reference/actions#delete-an-artifact

```php
$client->api('repo')->artifacts()->delete('KnpLabs', 'php-github-api', $artifactId);
Expand All @@ -36,7 +36,7 @@ $client->api('repo')->artifacts()->delete('KnpLabs', 'php-github-api', $artifact

### Download an artifact

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#download-an-artifact
https://docs.github.com/en/rest/reference/actions#download-an-artifact

```php
$artifactFile = $client->api('repo')->artifacts()->download('KnpLabs', 'php-github-api', $artifactId, $format = 'zip');
Expand Down
12 changes: 6 additions & 6 deletions doc/repo/actions/secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@

### List repository secrets

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#list-repository-secrets
https://docs.github.com/en/rest/reference/actions#list-repository-secrets

```php
$secrets = $client->api('repo')->secrets()->all('KnpLabs', 'php-github-api');
```

### Get a repository secret

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#get-a-repository-secret
https://docs.github.com/en/rest/reference/actions#get-a-repository-secret

```php
$secret = $client->api('repo')->secrets()->show('KnpLabs', 'php-github-api', $secretName);
```

### Create a repository secret

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#create-or-update-a-repository-secret
https://docs.github.com/en/rest/reference/actions#create-or-update-a-repository-secret

```php
$client->api('repo')->secrets()->create('KnpLabs', 'php-github-api', $secretName, [
Expand All @@ -29,7 +29,7 @@ $client->api('repo')->secrets()->create('KnpLabs', 'php-github-api', $secretName

### Update a repository secret

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#create-or-update-a-repository-secret
https://docs.github.com/en/rest/reference/actions#create-or-update-a-repository-secret

```php
$client->api('repo')->secrets()->update('KnpLabs', 'php-github-api', $secretName, [
Expand All @@ -39,15 +39,15 @@ $client->api('repo')->secrets()->update('KnpLabs', 'php-github-api', $secretName

### Delete a repository secret

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#delete-a-repository-secret
https://docs.github.com/en/rest/reference/actions#delete-a-repository-secret

```php
$client->api('repo')->secrets()->remove('KnpLabs', 'php-github-api', $secretName);
```

### Get a repository public key

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#get-a-repository-public-key
https://docs.github.com/en/rest/reference/actions#get-a-repository-public-key

```php
$publicKey = $client->api('repo')->secrets()->publicKey('KnpLabs', 'php-github-api');
Expand Down
8 changes: 4 additions & 4 deletions doc/repo/actions/self_hosted_runners.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,31 @@

# List self-hosted runners for a repository

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#list-self-hosted-runners-for-a-repository
https://docs.github.com/en/rest/reference/actions#list-self-hosted-runners-for-a-repository

```php
$runners = $client->api('repo')->selfHostedRunners()->all('KnpLabs', 'php-github-api');
```

# Get a self-hosted runner for a repository

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#get-a-self-hosted-runner-for-a-repository
https://docs.github.com/en/rest/reference/actions#get-a-self-hosted-runner-for-a-repository

```php
$runner = $client->api('repo')->selfHostedRunners()->show('KnpLabs', 'php-github-api', $runnerId);
```

# Delete a self-hosted runner from a repository

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository
https://docs.github.com/en/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository

```php
$client->api('repo')->selfHostedRunners()->remove('KnpLabs', 'php-github-api', $runnerId);
```

# List runner applications for a repository

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#list-runner-applications-for-a-repository
https://docs.github.com/en/rest/reference/actions#list-runner-applications-for-a-repository

```php
$applications = $client->api('repo')->selfHostedRunners()->applications('KnpLabs', 'php-github-api');
Expand Down
6 changes: 3 additions & 3 deletions doc/repo/actions/workflow_jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@

### List jobs for a workflow run

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#list-jobs-for-a-workflow-run
https://docs.github.com/en/rest/reference/actions#list-jobs-for-a-workflow-run

```php
$client->api('repo')->workflowJobs()->all('KnpLabs', 'php-github-api', $runId);
```

### Get a job for a workflow run

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#get-a-job-for-a-workflow-run
https://docs.github.com/en/rest/reference/actions#get-a-job-for-a-workflow-run

```php
$job = $client->api('repo')->workflowJobs()->all('KnpLabs', 'php-github-api', $jobId);
```

### Download job logs for a workflow run

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#download-job-logs-for-a-workflow-run
https://docs.github.com/en/rest/reference/actions#download-job-logs-for-a-workflow-run

```php
$jobLogs = $client->api('repo')->workflowJobs()->downloadLogs('KnpLabs', 'php-github-api', $jobId);
Expand Down
18 changes: 9 additions & 9 deletions doc/repo/actions/workflow_runs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,63 +3,63 @@

### List workflow runs for a repository

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#list-workflow-runs-for-a-repository
https://docs.github.com/en/rest/reference/actions#list-workflow-runs-for-a-repository

```php
$workflowRuns = $client->api('repo')->workflowRuns()->all('KnpLabs', 'php-github-api');
```

### List workflow runs

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#list-workflow-runs
https://docs.github.com/en/rest/reference/actions#list-workflow-runs

```php
$runs = $client->api('repo')->workflowRuns()->listRuns('KnpLabs', 'php-github-api', $workflow);
```

### Get a workflow run

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#get-a-workflow-run
https://docs.github.com/en/rest/reference/actions#get-a-workflow-run

```php
$workflowRun = $client->api('repo')->workflowRuns()->show('KnpLabs', 'php-github-api', $runId);
```

### Delete a workflow run

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#delete-a-workflow-run
https://docs.github.com/en/rest/reference/actions#delete-a-workflow-run

```php
$client->api('repo')->workflowRuns()->remove('KnpLabs', 'php-github-api', $runId);
```

### Re-run a workflow

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#re-run-a-workflow
https://docs.github.com/en/rest/reference/actions#re-run-a-workflow

```php
$client->api('repo')->workflowRuns()->rerun('KnpLabs', 'php-github-api', $runId);
```

### Cancel a workflow run

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#cancel-a-workflow-run
https://docs.github.com/en/rest/reference/actions#cancel-a-workflow-run

```php
$client->api('repo')->workflowRuns()->cancel('KnpLabs', 'php-github-api', $runId);
```

### Get workflow run usage

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#get-workflow-run-usage
https://docs.github.com/en/rest/reference/actions#get-workflow-run-usage

```php
$workflowUsage = $client->api('repo')->workflowRuns()->usage('KnpLabs', 'php-github-api', $runId);
```

### Download workflow run logs

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#download-workflow-run-logs
https://docs.github.com/en/rest/reference/actions#download-workflow-run-logs

```php
$logs = $client->api('repo')->workflowRuns()->downloadLogs('KnpLabs', 'php-github-api', $runId);
Expand All @@ -69,7 +69,7 @@ file_put_contents('logs.zip', $logs);

### Delete workflow run logs

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#delete-workflow-run-logs
https://docs.github.com/en/rest/reference/actions#delete-workflow-run-logs

```php
$client->api('repo')->workflowRuns()->deleteLogs('KnpLabs', 'php-github-api', $runId);
Expand Down
8 changes: 4 additions & 4 deletions doc/repo/actions/workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,31 @@

### List repository workflows

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#list-repository-workflows
https://docs.github.com/en/rest/reference/actions#list-repository-workflows

```php
$workflows = $client->api('repo')->workflows()->all('KnpLabs', 'php-github-api');
```

### Get a workflow

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#get-a-workflow
https://docs.github.com/en/rest/reference/actions#get-a-workflow

```php
$workflow = $client->api('repo')->workflows()->show('KnpLabs', 'php-github-api', $workflow);
```

### Get workflow usage

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#get-workflow-usage
https://docs.github.com/en/rest/reference/actions#get-workflow-usage

```php
$usage = $client->api('repo')->workflows()->usage('KnpLabs', 'php-github-api', $workflow);
```

### Dispatch a workflow

https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#create-a-workflow-dispatch-event
https://docs.github.com/en/rest/reference/actions#create-a-workflow-dispatch-event

```php
$client->api('repo')->workflows()->dispatches('KnpLabs', 'php-github-api', $workflow, 'main');
Expand Down
Loading