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.
0.42.0 - 2024-11-13
- added ssh_signing_keys ops (#725)
- Secrets and Code scanning alerts API (#730)
- add support for custom executors (#728)
- Fixup route in api/issues/update (#732)
0.41.2 - 2024-10-15
- Update tower dependency from 0.4.13 to 0.5.1 (#722)
- added user's social accounts operations (/user/social_accounts) (#723)
- added auth.user's git_ssh_keys operations (#719)
- Remove --verbose (#716)
0.41.1 - 2024-10-10
- don't capture backtraces by default (#710)
- added user's gpg_keys operations (#717)
- Secrecy dependency update from 0.8.0 to 0.10.3 (#718)
- Added handlers for Repo Dependabot API (#714)
- #552 (emails, public_emails, visibility) (#712)
- make some fields to public (#708)
- Implement some style improvements (#698)
0.41.0 - 2024-09-30
- Implement getting users and reopos by their respective IDs (#690)
- (installation) [breaking] Return Result instead of panicking in
Octocrab::installation
(#687)
- Update tower-http requirement from 0.5.1 to 0.6.1 (#701)
- add additional webhook model fields (#696)
- Bump hyper-rustls version. (#699)
0.40.0 - 2024-09-22
- Support
remove_assignees
on issue API (#686) - add missing fields in
CreateForkBuilder
(#682) - Add
Gist::public
field (#678)
- (refs) [breaking] remove
Reference::Commit
variant (#697)
- Fix typo in cfg_attr statement (#693)
- Handle empty author object in pr_commits (#656)
- Add
DeviceCodes::poll_until_available
method (#679) - Uncomment pr_commits function (#680)
- Only add base_path if req_pandq does not contain it (#684)
- Update code scanning alert (#673)
- Added
merged_by
andclosed_by
fields (#674) - Update and Fixes to the Code Scanning Models & Webhooks (#675)
0.39.0 - 2024-07-30
- support permission on list_collaborators (#630)
- add check run pull requests and list parameters (#494)
- implement hook deliveries (#668)
- allow sending non String payload with execute (#665)
- added /user/blocks functionality (#657)
- add method to create repo webhook (#640)
- use put instead of get for set_thread_subscription (#661)
- (builder) Change add_retry_config signature to match others in OctocrabBuilder (#643)
- getting Code Scanning (#669)
- added missing /repos/{owner}/{repo}/pulls/... handlers (#546) (#605)
- Properly mark feature-gated functionality in docs (#662)
- repos/releases improvements (#666)
- Add AutoRebaseEnabled to models.rs (#660)
- cargo fmt (#658)
- Fix issue #635 (#637)
- Update issues.rs (#634)
- Add head repo to create pr (#636)
- Added support for make_latest in UpdateReleaseBuilder (#646)
- Changing the user name from required to optional parameter (#650)
- Update models.rs (#651)
0.38.0 - 2024-04-09
- Add
generate_release_notes
: (#588)
- Unify diff entry models (#624)
- Added tests for .delete_thread_subscriptions() (#620)
- Adding tests, and fixing missing error code. (#619)
0.37.0 - 2024-03-27
- [breaking] Change
Rate::reset
tou64
(#615)
- Update graphql_client requirement from 0.13.0 to 0.14.0 (#617)
- Added basic support for getting user profiles (#616)
- Update manual github app authentication example (#610)
0.36.0 - 2024-03-19
- WASM Support (#591)
- fix some comments (#611)
- Add status code to GithubError (#607)
- Add
Pending
variant tooctocrab::models::workflows::Status
(#604) - Fix personal token auth for pagination (#602)
- Fixed some
.gists()
functions, and wrote tests. (#606) - Allow directly passing SecretString (#601)
0.35.0 - 2024-03-10
- add repository list language support (#595)
- Added test for
actions().create_workflow_dispatch()
(#603) - added "Create a new Git commit object" (#600)
- Added
check-suites
endpoints (#596) - Adding org secrets tests (#599)
0.34.3 - 2024-03-05
- Add delete_ref in RepoHandler (#573)
- Adding tests to
orgs().secrets().create_or_update_secret()
(#590)
0.34.2 - 2024-03-04
- Update base64 requirement from 0.21.0 to 0.22.0 (#592)
- Add Public and Release events (#589)
- Adding tests for
actions().remove_selected_repo_from_org_secret()
(#586) - Fixed the `projects().delete_project().send() function (#587)
- Added more tests, for
repos().delete()
(#585) - Adding test for actions().actions_delete_workflow_run_logs_test() (#584)
- Fixing
snafu
version update (#580) - Fixing the test that
wiremock@v0.6.0
breaks. (#579) - Added some more tests (#578)
- Added a test (#577)
0.34.1 - 2024-02-09
- Added tests to prove
repos().secrets().delete_secret()
(#570) - Adding test for
issues().delete_comment()
(#569) - Fixed
issues().delete_comment_reaction()
(#566)
0.34.0 - 2024-02-07
- Upgrade http/hyper 1.0 (#564)
0.33.4 - 2024-02-06
- Don't send Authorization headers to third-party services. (#562)
- Added tests for
repos().merges()
(#560)
0.33.3 - 2024-01-26
- Handle redirects in ReleasesHandler::stream_asset(). (#556)
- Tests for locking and unlocking issue comments (#557)
0.33.2 - 2024-01-24
- Resolving issue with deleting reactions from issues. (#555)
- Added a test for
repos().is_collaborator()
. The 204 case is good! (#553)
- Added a test case for
repos().is_collaborator()
to cover both 204 and 404 cases.
0.33.1 - 2024-01-15
- fixed timeout methods not being feature gated (#519)
0.33.0 - 2024-01-15
- add methods to builder for changing timeouts (#498)
- Always set http request header
CONTENT-LENGTH
(#464) - Add link to
Content::decoded_content
(#514) - Repairing two 204-related serde errors, and adding some simple tests. (#503)
- Add CheckRunOutput (#515)
- cargo clippy --tests --examples --fix (#496)
- make dismissal_message optional (#501)
- Add conclusion, completed_at and output fields to create check api (#467)
- Fix typo in docs (#508)
- [docs] Improve the update_file docs (#513)
- added repos/list_contributors (#500)
- Make user information optional
- Use graphql_client to get stronger typing
- add fields for refresh token and expiry timestamps (#477)
- Fixed two functions which return 204s and have no body, which throws serde errors
octocrab.issues().delete_label()
octocrab.teams().repos().remove()
- Added tests for the above functions
- Also added tests for
octocrab.teams().repos().add_or_update()
- Also added tests for
octocrab.issues().remove_label()
0.32.0 - 2023-11-01
- support eq and hash (#480)
- Demonstrate variables and paging (#481)
- Fix a bunch of clippy issues (#482)
- add events for auto_merge_[disabled|enabled] (#479)
- Add examples/graphql_issues.rs (#478)
- Document the PullRequest number field (#476)
- Update jsonwebtoken requirement from 8 to 9 (#471)
0.31.2 - 2023-10-15
- Add
follow-redirect
feature (#469)
0.31.1 - 2023-10-08
- add get_readme for RepoHandler (#465)
0.31.0 - 2023-10-02
0.30.1 - 2023-09-04
- add tracing debug only when tracing feature is enabled (#454)
0.30.0 - 2023-09-01
- Fix commit_comment webhook event parsing (#453)
- Add Octocrab::users() and UsersHandler::repos (#451)
- Add CommitHandler::associated_check_runs (#450)
- Fix installation token cache issue (#442)
- Add projects Api (#447)
- Enhance installation webhook events
- Add test for push webhook event
- Implement custom deserialization for hybrid Github API timestamps
- Make webhook_events deserialization tests more robust
0.29.3 - 2023-08-15
- add
WebhookEventType::Schedule
variant
0.29.2 - 2023-08-14
- fix get_asset url
- Add optional email field to Author
- Add get_org_installation to AppsRequestHandler
- Update CHANGELOG.md
0.29.1 - 2023-07-31
- Make models::webhook_events::payload public
0.29.0 - 2023-07-30
- 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
- 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
- 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
- Pass through hyper-rustls/webpki-tokio (#392)
0.25.0 - 2023-06-03
- 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
- 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
- Add "updated since" support to ListIssuesBuilder (#373)
- Gists API: Complete support (#371)
- Add more fields (#369)
0.22.0 - 2023-05-16
- 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
- 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
- Handle
DELETE /gists/{gist_id}
(#333)
0.20.0-alpha.2 - 2023-04-10
- Extend
GistsHandler
throughstar(...)
,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
- Fix GitHubError / InvalidUri(InvalidFormat) (#320)
- Fix the spelling of
committer
inRepoCommitPage
(#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)
- [
UpdateIssueBuilder::state_reason
] Updates the state reason.
- Relaxed the
body
argument onOctocrab::graphql
fromimpl 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 likegraphql_client
directly.
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
Organisationspulls
Pull Requestsrepos
Repositoriessearch
Search using GitHub's query syntax.
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.
Page<T>
now has new fields for being used with GitHub's search APi such asincomplete_results
andtotal_count
.