Changelog

All Octocrab releases are supported by the community and through GitHub Sponsors.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

0.29.1 - 2023-07-31

Other

Make models::webhook_events::payload public

0.29.0 - 2023-07-30

Other

Add webhook event deserialization (#427)
Update changelog for v0.28.0 (#428)
Add associated pull requests and commit compare functionality (#413)
Fix clippy 1.71 warnings (#424)

0.28.0 - 2023-07-19

Other

Handle errors when kicking off github workflows (#409)
Update license field following https://doc.rust-lang.org/cargo/reference/manifest.html#the-license-and-license-file-fields (#412)
cargo clippy --tests (#416)
Improve workflow job types (#414)
Fix graphql example (#404)

0.27.0 - 2023-07-18

Other

Handle errors when kicking off github workflows (#409)
Update license field following https://doc.rust-lang.org/cargo/reference/manifest.html#the-license-and-license-file-fields (#412)
cargo clippy --tests (#416)
Improve workflow job types (#414)
Fix graphql example (#404)

0.25.1 - 2023-06-06

Other

Pass through hyper-rustls/webpki-tokio (#392)

0.25.0 - 2023-06-03

Other

Add User Access Authentication (#375)
Add allow_forking & allow_update_branch in Repository model (#379)
added org secrets api (#384)

0.24.0 - 2023-06-02

Fixed

the API returns one reviewer not reviewers (#390)
wrap pull_request_review_id in an Option (#388)

Other

Add Issue Timeline API (#389)
add some of the missing fields to PullRequest (#386)
Builder for list_reviews for pulls (#387)
Link to gists documentation in README (#383)

0.23.0 - 2023-05-21

Other

Add "updated since" support to ListIssuesBuilder (#373)
Gists API: Complete support (#371)
Add more fields (#369)

0.22.0 - 2023-05-16

Other

Add leading / to NotificationsHandler.lists() (#364)
Alter graphql method to pass arbitrarily complex payloads (variables and graphql-client support) (#332)
Fix authentication endpoints (#354)
Handle redirects for download_tarball (#359)
Make building without the retry feature work. (#358)
Add list_org_memberships_for_authenticated_user (#357)
add Uploader struct for Asset uploader field (#355)

0.21.0 - 2023-04-29

Other

Add an example showing gist creation (#329)
Use CommitAuthor for Commit.author (#353)
Create release-plz.toml
Sort deps in cargo.toml (#352)
Enable rustls(and use as default client) (#351)
(ci) update release-plz version (#350)
Add missing pub to struct ListCheckRuns 😅 (#347)
Add Checks API skeleton (#345)
cargo fmt (#343)
Remove reqwest (#342)

0.20.0-alpha.3 - 2023-04-12

Other

Handle DELETE /gists/{gist_id} (#333)

0.20.0-alpha.2 - 2023-04-10

Other

Extend GistsHandler through star(...), unstar(...), is_starred(...) (#330)
added poll org events (#325)
Add CurrentAuthHandler::list_gists_for_authenticated_user (#328)
Fix typo in POST /gists endpoint (#327)
Update hyper-rustls requirement from 0.23.2 to 0.24.0 (#324)
Percent encode label name in remove_label to avoid InvalidUri(InvalidUriChar) error (#323)

0.20.0-alpha.1 - 2023-03-31

Other

Fix GitHubError / InvalidUri(InvalidFormat) (#320)
Fix the spelling of committer in RepoCommitPage (#316) (#317)
Add update state reason (#290)
Add target URL to Status model (#308)
(ci) add release-plz (#309)
Add remove_requested_reviewer function (#312)
Make command compatible with copy paste (#318)
Update tower-http requirement from 0.3.2 to 0.4.0 (#315)

Added Methods

[UpdateIssueBuilder::state_reason] Updates the state reason.

0.4.1

Relaxed the body argument on Octocrab::graphql from impl AsRef<str> to &impl serde::Serialize + ?Sized to allow accepting any valid JSON value. This is mainly useful for being able to use types from other libraries like graphql_client directly.

0.4.0

New APIs

actions Control and automate GitHub Actions.
current Metadata about the currently authenticated user.
gitignore Get and generate gitignore templates.
licenses Metadata about licenses.
markdown Render markdown with GitHub.
orgs Organisations
pulls Pull Requests
repos Repositories
search Search using GitHub's query syntax.

Added Methods

Octocrab::graphql Send a GraphQL request.
IssueHandler::lock Lock a GitHub issue with an optional reason.
IssueHandler::unlock Unlock a GitHub issue.
IssueHandler::replace_all_labels Replace all labels on an issue.
IssueHandler::delete_label Remove labels from an issue.
IssueHandler::list_labels_for_issue List all labels on an issue.
IssueHandler::list_labels_for_repo List all labels in a repository.
PullRequestHandler::media_type Set the media type for a single request.
PullRequestHandler::get_diff Get a pull request's diff file.
PullRequestHandler::get_patch Get a pull request's patch file.
Page::number_of_pages Get the number of pages in a paginated query if possible.

Changes

Page<T> now has new fields for being used with GitHub's search APi such as incomplete_results and total_count.