schedule:

-cron:"27 0 * * *"

push:

branches:["main"]

branches:["main", "next"]

tags:["v*.*.*"]

pull_request:

branches:["main"]

branches:["main", "next"]

env:

1.[Fork][fork] and clone the repository

1. Make sure the tests pass on your machine:`go test -v ./...`

1. Make sure linter passes on your machine:`golangci-lint run`

1. Create a new branch:`git checkout -b my-branch-name`

1. Make your change, add tests, and make sure the tests and linter still pass

1. Push to your fork and[submit a pull request][pr]

1. Push to your fork and[submit a pull request][pr] targeting the`next` branch

1. Pat yourself on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

<details>

<summary>Context</summary>

-**get_me** - Get details of the authenticated user

- No parameters required

</details>

<details>

<summary>Issues</summary>

-**get_issue** - Gets the contents of an issue within a repository

-`issueNumber`: Issue number (number, required)

-_Note_: This tool can help with creating a Pull Request with source code changes to resolve the issue. More information can be found at[GitHub Copilot documentation](https://docs.github.com/en/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot)

</details>

<details>

<summary>Pull Requests</summary>

-**get_pull_request** - Get details of a specific pull request

-`pullNumber`: Pull request number (number, required)

-_Note_: Currently, this tool will only work for github.com

</details>

<details>

<summary>Repositories</summary>

-**create_or_update_file** - Create or update a single file in a repository

-`owner`: Repository owner (string, required)

-`page`: Page number (number, optional)

-`perPage`: Results per page (number, optional)

</details>

<details>

<summary>Users</summary>

-**search_users** - Search for GitHub users

-`q`: Search query (string, required)

-`page`: Page number (number, optional)

-`perPage`: Results per page (number, optional)

</details>

<details>

<summary>Actions</summary>

-**list_workflows** - List workflows in a repository

-`repo`: Repository name (string, required)

-`run_id`: Workflow run ID (number, required)

</details>

<details>

<summary>Code Scanning</summary>

-**get_code_scanning_alert** - Get a code scanning alert

-`severity`: Alert severity (string, optional)

-`tool_name`: The name of the tool used for code scanning (string, optional)

</details>

<details>

<summary>Secret Scanning</summary>

-**get_secret_scanning_alert** - Get a secret scanning alert

-`secret_type`: The secret types to be filtered for in a comma-separated list (string, optional)

-`resolution`: The resolution status (string, optional)

</details>

<details>

<summary>Notifications</summary>

-**list_notifications** – List notifications for a GitHub user

-`filter`: Filter to apply to the response (`default`,`include_read_notifications`,`only_participating`)

-`repo`: The name of the repository (string, required)

-`action`: Action to perform:`ignore`,`watch`, or`delete` (string, required)

</details>

<details>

<summary>Repository Content</summary>

-**Get Repository Content**

Retrieves the content of a repository at a specific path.

-`prNumber`: Pull request number (string, required)

-`path`: File or directory path (string, optional)

</details>

The exported Go API of this module should currently be considered unstable, and subject to breaking changes. In the future, we may offer stability; please file an issue if there is a use case where this would be valuable.