diff --git a/plugins/catalog/catalog.go b/plugins/catalog/catalog.go index 3e62488..aaf2470 100644 --- a/plugins/catalog/catalog.go +++ b/plugins/catalog/catalog.go @@ -4,7 +4,8 @@ // name (and, for a list of upcoming changes, its date and what to use // instead). Each reader is a plugin of its own in this package, read // version by version (plugin.Versioned): Redis's commands at each release -// tag (redis.go). +// tag (redis.go), GitHub's GraphQL upcoming changes at each commit +// (graphql.go). // // Precision over recall: a name that moves (a genuine rename) reads as one // removal and one addition, same as any other. A reader never guesses a @@ -28,13 +29,29 @@ func init() { Plugin: Redis, }}, }) + plugin.RegisterProvider(plugin.Provider{ + ID: "github", Name: "GitHub", Category: plugin.CategoryDevTools, Homepage: "https://github.com", + Sources: []plugin.Source{{ + ID: "graphql", Layer: plugin.LayerAPI, Page: "providers/github-graphql.md", + Watches: "GraphQL API fields, arguments, input fields and enum values GitHub announces it will remove, with the date, from the file its breaking-changes page is built from", + URLs: []string{"https://docs.github.com/en/graphql/overview/breaking-changes", "https://github.com/github/docs/blob/main/src/graphql/data/fpt/upcoming-changes.json"}, + Packages: []string{"npm:@octokit/graphql"}, + Plugin: GitHubGraphQL, + }}, + }) } // finish fingerprints and validates the events a reader made, keeping the -// valid ones and the reasons the others failed. -func finish(api string, made []event.Event) (events []event.Event, rejected []error) { - for _, e := range made { - e.Fingerprint = event.Fingerprint(e.API, e.Version, e.ChangeType, e.Subject, "") +// valid ones and the reasons the others failed. details, when given, are +// the fingerprints' detail, one per event: what separates two changes at +// one location. +func finish(api string, made []event.Event, details []string) (events []event.Event, rejected []error) { + for i, e := range made { + detail := "" + if details != nil { + detail = details[i] + } + e.Fingerprint = event.Fingerprint(e.API, e.Version, e.ChangeType, e.Subject, detail) if err := e.Validate(); err != nil { rejected = append(rejected, fmt.Errorf("%s %s: %w", api, e.Description, err)) continue diff --git a/plugins/catalog/graphql.go b/plugins/catalog/graphql.go new file mode 100644 index 0000000..511f94b --- /dev/null +++ b/plugins/catalog/graphql.go @@ -0,0 +1,199 @@ +package catalog + +import ( + "context" + "encoding/json" + "fmt" + "html" + "regexp" + "sort" + "strings" + + "github.com/patch-it-dev/patch-it-plugins/core/event" + "github.com/patch-it-dev/patch-it-plugins/core/github" + "github.com/patch-it-dev/patch-it-plugins/core/plugin" + "github.com/patch-it-dev/patch-it-plugins/core/versions" +) + +// UpcomingChanges is a GraphQL API's file of announced removals, kept in a +// repo and read at each commit that changed it: GitHub's +// src/graphql/data/fpt/upcoming-changes.json in github/docs, which +// docs.github.com's "Breaking changes" page is built from. The file is an +// object keyed by removal date, each a list of {location, description, +// reason, date, criticality}: location is "Type.field" (or +// "Type.field.argument"), date the day it goes. +// +// A version is a commit (its date, its SHA). An entry in to's file that +// from's didn't have is a newly announced removal: a deprecation event on +// that location whose version is the removal date (GitHub's GraphQL API has +// no versions of its own, so the day it breaks is the one to gate on, as a +// model's shutdown date is), with previous_version the commit before. An +// entry a commit drops and a later one restores, with the same date, is then +// the same event again, which the store dedupes by fingerprint. An entry dated before the commit that +// adds it isn't an announcement (a revert putting back a removal already +// made: the file lost and regained 17 such entries on 2026-01-05 and 06), and +// an entry that leaves the file isn't read: it shipped, or was withdrawn, +// and the file doesn't say which. +type UpcomingChanges struct { + API string // the source id the events carry: "github/graphql" + Vendor string // for sentences: "GitHub" + Repo string // owner/name on GitHub + Path string // the file's path in the repo + // Endpoint is the GraphQL endpoint as an operation: every query and + // mutation is a POST to it ("POST /graphql"). + Endpoint string +} + +// GitHubGraphQL is GitHub's GraphQL API's upcoming changes (checked +// 2026-11-21: 1,291 entries, every one "criticality": "breaking", 29 +// commits since 2023-05-01). +var GitHubGraphQL = UpcomingChanges{ + API: "github/graphql", Vendor: "GitHub", + Repo: "github/docs", Path: "src/graphql/data/fpt/upcoming-changes.json", + Endpoint: "POST /graphql", +} + +func (u UpcomingChanges) Name() string { return u.API } + +// FileURL is the file at a commit: its own provenance. +func (u UpcomingChanges) FileURL(sha string) string { + return fmt.Sprintf("%s/%s/%s/%s", github.Raw, u.Repo, sha, u.Path) +} + +// ListVersions is every commit that changed the file, oldest first. +func (u UpcomingChanges) ListVersions(ctx context.Context, env plugin.Env) ([]plugin.Version, error) { + return versions.GitHubCommits(ctx, env.Get, u.Repo, u.Path) +} + +// ReadAt fetches the file at v's commit. +func (u UpcomingChanges) ReadAt(ctx context.Context, env plugin.Env, v plugin.Version) (plugin.Snapshot, error) { + url := u.FileURL(v.Ref) + body, err := env.Get(ctx, url) + if err != nil { + return plugin.Snapshot{}, fmt.Errorf("fetching %s: %w", url, err) + } + return plugin.Snapshot{Version: v, Content: body, SourceURL: url}, nil +} + +// upcoming is one entry of the file: the fields read, in the file's order, +// which is also how an event quotes it (the entry's "owner", a GitHub team +// or handle, is left out). +type upcoming struct { + Location string `json:"location"` + Description string `json:"description"` + Reason string `json:"reason"` + Date string `json:"date"` + Criticality string `json:"criticality"` +} + +func (e upcoming) key() string { return e.Location + "@" + e.Date } + +// entries reads the file: every entry, in the file's order of dates. +func entries(body []byte) ([]upcoming, error) { + var byDate map[string][]json.RawMessage + if err := json.Unmarshal(body, &byDate); err != nil { + return nil, err + } + dates := make([]string, 0, len(byDate)) + for d := range byDate { + dates = append(dates, d) + } + sort.Strings(dates) + var out []upcoming + for _, d := range dates { + for _, r := range byDate[d] { + var e upcoming + if err := json.Unmarshal(r, &e); err != nil { + return nil, err + } + out = append(out, e) + } + } + return out, nil +} + +var gqlTag = regexp.MustCompile(`<[^>]+>`) + +// gqlText is an entry's HTML as one plain sentence. +func gqlText(s string) string { + return strings.Join(strings.Fields(html.UnescapeString(gqlTag.ReplaceAllString(s, ""))), " ") +} + +// Extract is a deprecation event per entry in to's file that from's didn't +// have, dated before to's commit or not at all excluded (see +// UpcomingChanges), with previous_version from's commit. A zero from has +// nothing to compare. +func (u UpcomingChanges) Extract(_ context.Context, env plugin.Env, from, to plugin.Snapshot) (plugin.Result, error) { + if from.IsZero() { + return plugin.Result{}, nil + } + before, err := entries(from.Content) + if err != nil { + return plugin.Result{}, fmt.Errorf("reading %s: %w", from.SourceURL, err) + } + after, err := entries(to.Content) + if err != nil { + return plugin.Result{}, fmt.Errorf("reading %s: %w", to.SourceURL, err) + } + had := map[string]bool{} + for _, e := range before { + had[e.key()] = true + } + var made []event.Event + var details []string + for _, e := range after { + if had[e.key()] || e.Date < to.Version.ID || e.Criticality != "breaking" { + continue + } + subject, ok := u.subject(e.Location) + if !ok { + continue + } + var quote strings.Builder + enc := json.NewEncoder("e) + enc.SetEscapeHTML(false) + if err := enc.Encode(e); err != nil { + return plugin.Result{}, err + } + hint := gqlText(e.Description) + if r := gqlText(e.Reason); r != "" && r != hint { + hint += " " + r + } + made = append(made, event.Event{ + API: u.API, Version: e.Date, PreviousVersion: from.Version.ID, + ChangeType: event.ChangeTypeDeprecation, + Subject: subject, + Description: fmt.Sprintf("%s's GraphQL API removes %s on %s: code that queries or sends it fails from that date.", + u.Vendor, e.Location, e.Date), + MigrationHint: hint, + SourceURL: to.SourceURL, + SourceExcerpt: excerpt(strings.TrimSpace(quote.String())), + Confidence: 1.0, + DetectedAt: env.Now().UTC(), + }) + details = append(details, "") + } + events, rejected := finish(u.API, made, details) + return plugin.Result{Events: events, Rejected: rejected}, nil +} + +// subject places a location in the contract's api_operation: an input +// object's field, or an argument of a root field (Query.field.argument), is +// a request parameter of the endpoint; any other location (a field, a root +// field itself, a field's argument, an enum's value) is a property of its +// type, as a schema. +func (u UpcomingChanges) subject(location string) (event.Subject, bool) { + typ, rest, ok := strings.Cut(location, ".") + if !ok || typ == "" || rest == "" { + return event.Subject{}, false + } + root := typ == "Query" || typ == "Mutation" || typ == "Subscription" + if strings.HasSuffix(typ, "Input") || (root && strings.Contains(rest, ".")) { + return event.Subject{Type: event.SubjectAPIOperation, Kind: event.KindRequestParameter, Side: event.SideRequest, + Operation: u.Endpoint, Property: location}, true + } + return event.Subject{Type: event.SubjectAPIOperation, Kind: event.KindSchemaProperty, Side: event.SideResponse, + Schema: typ, Property: rest}, true +} + +var _ plugin.Versioned = UpcomingChanges{} diff --git a/plugins/catalog/graphql_test.go b/plugins/catalog/graphql_test.go new file mode 100644 index 0000000..632ccbd --- /dev/null +++ b/plugins/catalog/graphql_test.go @@ -0,0 +1,145 @@ +package catalog + +import ( + "context" + "fmt" + "strings" + "testing" + + "github.com/patch-it-dev/patch-it-plugins/core/event" + "github.com/patch-it-dev/patch-it-plugins/core/kit/kittest" + "github.com/patch-it-dev/patch-it-plugins/core/plugin" + "github.com/patch-it-dev/patch-it-plugins/core/versions" +) + +// The commits of github/docs the saved files are at (testdata/README.md), +// oldest first, as GitHub's commit list names them. +var graphqlCommits = []plugin.Version{ + {ID: "2026-01-05", Ref: "fc26275f90e62249fabc0f287255b3e5e60cb6e8"}, + {ID: "2026-01-06", Ref: "54c26c43342f7818c4001af7eaf6a3295e3f822d"}, + {ID: "2026-01-08", Ref: "2706f417a6afec24c57482d62f70035ee35c10fb"}, + {ID: "2026-02-13", Ref: "fc7cedfe9c6b2c0a40fd213cd18c0afc774b67fc"}, + {ID: "2026-03-03", Ref: "3a14e541873e834edf32b43b71911fe80d109a70"}, + {ID: "2026-05-22", Ref: "a934f06d211bef668253e3826c118a4e559dc1ba"}, + {ID: "2026-06-23", Ref: "c5738e5815fff90d38f0166f7c9949bfb664e003"}, +} + +func graphqlPages() kittest.Pages { + pages := kittest.Pages{} + for _, v := range graphqlCommits { + pages[GitHubGraphQL.FileURL(v.Ref)] = "testdata/github-graphql-upcoming-changes-" + v.Ref[:8] + ".json" + } + return pages +} + +func graphqlPair(t *testing.T, from, to plugin.Version) []event.Event { + t.Helper() + return kittest.Versions(t, kittest.Env(t, graphqlPages()), GitHubGraphQL, from, to) +} + +// The golden test: four consecutive commits, three pairs. 2026-03-03 adds +// CheckAnnotation.databaseId and Artifact.databaseId (removed on +// 2027-01-01, in the file's order), 2026-05-22 User.viewerRelevantRepositories +// and 2026-06-23 CopilotAgentTask.type (both 2026-10-01). Every entry the +// commits share is no event. +func TestGraphQLGolden(t *testing.T) { + var got []event.Event + var names []string + for _, pair := range versions.Pairs(graphqlCommits[3:]) { + for _, e := range graphqlPair(t, pair[0], pair[1]) { + got = append(got, e) + names = append(names, fmt.Sprintf("%s->%s %s.%s", e.PreviousVersion, pair[1].ID, e.Subject.Schema, e.Subject.Property)) + } + } + want := "2026-02-13->2026-03-03 CheckAnnotation.databaseId | 2026-02-13->2026-03-03 Artifact.databaseId | 2026-03-03->2026-05-22 User.viewerRelevantRepositories | 2026-05-22->2026-06-23 CopilotAgentTask.type" + if strings.Join(names, " | ") != want { + t.Errorf("got %s\nwant %s", strings.Join(names, " | "), want) + } + for _, e := range got { + if e.ChangeType != event.ChangeTypeDeprecation || e.Subject.Kind != event.KindSchemaProperty || !strings.Contains(e.SourceExcerpt, `"criticality":"breaking"`) || strings.Contains(e.SourceExcerpt, "owner") { + t.Errorf("%+v", e) + } + } + for i := range got { + got[i].ID = 0 + } + kittest.Golden(t, "testdata/golden/github-graphql.json", got) +} + +// The pinned drop test: on 2026-01-05 the file lost 17 entries (removals +// dated 2024-07-01 to 2026-01-01, already made), got them back the next day +// and lost them again on 2026-01-08. Putting back a removal already past +// isn't an announcement, and an entry leaving the file says nothing: no +// event in either pair, though the second pair adds 17 entries. +func TestGraphQLRevertsAreNoAnnouncement(t *testing.T) { + for _, pair := range versions.Pairs(graphqlCommits[:3]) { + if got := graphqlPair(t, pair[0], pair[1]); len(got) != 0 { + t.Errorf("%s -> %s: %d events, want 0", pair[0].ID, pair[1].ID, len(got)) + } + } + // The second pair does add entries: what the date check drops. + from, _ := GitHubGraphQL.ReadAt(context.Background(), kittest.Env(t, graphqlPages()), graphqlCommits[0]) + to, _ := GitHubGraphQL.ReadAt(context.Background(), kittest.Env(t, graphqlPages()), graphqlCommits[1]) + a, _ := entries(from.Content) + b, _ := entries(to.Content) + if len(b)-len(a) != 17 { + t.Errorf("the re-added entries: %d, want 17", len(b)-len(a)) + } +} + +// An input object's field and a root field's argument are request +// parameters of POST /graphql; any other location is a property of its type. +func TestGraphQLLocations(t *testing.T) { + for loc, want := range map[string]string{ + "AddPullRequestReviewInput.comments": "request_parameter POST /graphql AddPullRequestReviewInput.comments", + "Query.sponsorables.dependencyEcosystem": "request_parameter POST /graphql Query.sponsorables.dependencyEcosystem", + "RepositoryPermission.TRIAGE_PLUS": "schema_property RepositoryPermission TRIAGE_PLUS", + "Issue.stateReason.enableDuplicate": "schema_property Issue stateReason.enableDuplicate", + } { + s, ok := GitHubGraphQL.subject(loc) + got := strings.Join(strings.Fields(fmt.Sprintf("%s %s %s %s", s.Kind, s.Operation, s.Schema, s.Property)), " ") + if !ok || got != want { + t.Errorf("%s: %q, want %q", loc, got, want) + } + } + if _, ok := GitHubGraphQL.subject("NoDot"); ok { + t.Error("a location without a field isn't read") + } +} + +func TestGraphQLVersionsAreTheFilesCommits(t *testing.T) { + env := kittest.Env(t, kittest.Pages{ + "https://api.github.com/repos/github/docs/commits?path=src%2Fgraphql%2Fdata%2Ffpt%2Fupcoming-changes.json&per_page=100&page=1": "testdata/github-commits-upcoming-changes-excerpt.json", + }) + vs, err := GitHubGraphQL.ListVersions(context.Background(), env) + if err != nil || len(vs) != 3 || vs[0].Ref != graphqlCommits[3].Ref || vs[2].ID != "2026-05-22" { + t.Errorf("%v %v", vs, err) + } +} + +// An entry a commit drops while still upcoming and a later commit restores +// is the same event: its version is the removal date, not the commit's, so +// the fingerprint matches and the store keeps one. +func TestGraphQLARestoredEntryIsTheSameEvent(t *testing.T) { + first := graphqlPair(t, graphqlCommits[3], graphqlCommits[4]) + // 2026-03-03's file without its two additions, then the file again. + from, err := GitHubGraphQL.ReadAt(context.Background(), kittest.Env(t, graphqlPages()), graphqlCommits[3]) + if err != nil { + t.Fatal(err) + } + to, err := GitHubGraphQL.ReadAt(context.Background(), kittest.Env(t, graphqlPages()), graphqlCommits[4]) + if err != nil { + t.Fatal(err) + } + from.Version = plugin.Version{ID: "2026-04-01", Ref: "dropped"} + to.Version = plugin.Version{ID: "2026-04-02", Ref: "restored"} + again, err := GitHubGraphQL.Extract(context.Background(), kittest.Env(t, nil), from, to) + if err != nil || len(again.Events) != len(first) { + t.Fatalf("%v, %d events", err, len(again.Events)) + } + for i, e := range again.Events { + if e.Version != "2027-01-01" || e.Fingerprint != first[i].Fingerprint { + t.Errorf("%s: version %s, same fingerprint %v", e.Subject.Property, e.Version, e.Fingerprint == first[i].Fingerprint) + } + } +} diff --git a/plugins/catalog/redis.go b/plugins/catalog/redis.go index 452245b..e78253c 100644 --- a/plugins/catalog/redis.go +++ b/plugins/catalog/redis.go @@ -155,7 +155,7 @@ func (c Commands) Extract(ctx context.Context, env plugin.Env, from, to plugin.S DetectedAt: env.Now().UTC(), }) } - events, rejected := finish(c.API, made) + events, rejected := finish(c.API, made, nil) return plugin.Result{Events: events, Rejected: rejected}, nil } diff --git a/plugins/catalog/registered_test.go b/plugins/catalog/registered_test.go index 653b731..1f8630c 100644 --- a/plugins/catalog/registered_test.go +++ b/plugins/catalog/registered_test.go @@ -8,4 +8,5 @@ import ( func TestRegistersItself(t *testing.T) { kittest.Registered(t, Redis) + kittest.Registered(t, GitHubGraphQL) } diff --git a/plugins/catalog/testdata/README.md b/plugins/catalog/testdata/README.md index f7f1f6b..f71b7c9 100644 --- a/plugins/catalog/testdata/README.md +++ b/plugins/catalog/testdata/README.md @@ -1,6 +1,6 @@ # Saved catalog snapshots -The golden file, `golden/redis-commands.json`, is what the catalog kind stores from the pair below (`go test ./plugins/catalog -update`). +The golden files, `golden/redis-commands.json` and `golden/github-graphql.json`, are what the catalog kind stores from the files below (`go test ./plugins/catalog -update`). | File | URL | Fetched | License | Quote | |---|---|---|---|---| @@ -10,3 +10,5 @@ The golden file, `golden/redis-commands.json`, is what the catalog kind stores f | `redis-8.8-m03-gcra.json` | https://raw.githubusercontent.com/redis/redis/8.8-m03/src/commands/gcra.json | 2026-11-20 | as above, kept whole, byte for byte | `"GCRA": {"summary": "Rate limit via GCRA (Generic Cell Rate Algorithm).", … "since": "8.8.0"` | | `redis-8.8-m03-gcrasetvalue.json` | https://raw.githubusercontent.com/redis/redis/8.8-m03/src/commands/gcrasetvalue.json | 2026-11-20 | as above, kept whole, byte for byte | `"GCRASETVALUE": {"summary": "An internal command for recording a GCRA TAT value during AOF rewrite and replication."` | | `redis-releases-excerpt.json` | https://api.github.com/repos/redis/redis/releases (shape only) | written for the test, 2026-11-20 | not a saved copy: five entries in the shape of GitHub's releases API (`tag_name`, `draft`, `prerelease`, `published_at`, `html_url`), dates approximate, a pre-release and a patch to an older line published later among them | for the version-listing test only | +| `github-graphql-upcoming-changes-.json` (seven) | https://github.com/github/docs/blob//src/graphql/data/fpt/upcoming-changes.json at fc26275f, 54c26c43, 2706f417 (2026-01-05 to 08) and fc7cedfe, 3a14e541, a934f06d, c5738e58 (2026-02-13 to 06-23) | 2026-11-21 | CC BY 4.0 (github/docs content). Excerpts for testing: each keeps the first entry under every date of the first file of its group, and every entry the group's commits add; every kept entry unchanged, in the file's order. The plugin finds the same additions between them as between the full files (2, 1, 1; and 17 re-added, past-dated) | `"location": "CheckAnnotation.databaseId", "description": "

databaseId will be removed. Use fullDatabaseId instead.

"` | +| `github-commits-upcoming-changes-excerpt.json` | https://api.github.com/repos/github/docs/commits?path=src/graphql/data/fpt/upcoming-changes.json (shape only) | written for the test, 2026-11-21 | not a saved copy: three of the real commits (SHA, date, URL), newest first as GitHub lists them | for the version-listing test only | diff --git a/plugins/catalog/testdata/github-commits-upcoming-changes-excerpt.json b/plugins/catalog/testdata/github-commits-upcoming-changes-excerpt.json new file mode 100644 index 0000000..0be001c --- /dev/null +++ b/plugins/catalog/testdata/github-commits-upcoming-changes-excerpt.json @@ -0,0 +1,5 @@ +[ + {"sha": "a934f06d211bef668253e3826c118a4e559dc1ba", "html_url": "https://github.com/github/docs/commit/a934f06d211bef668253e3826c118a4e559dc1ba", "commit": {"committer": {"date": "2026-05-22T17:14:56Z"}}}, + {"sha": "3a14e541873e834edf32b43b71911fe80d109a70", "html_url": "https://github.com/github/docs/commit/3a14e541873e834edf32b43b71911fe80d109a70", "commit": {"committer": {"date": "2026-03-03T16:45:09Z"}}}, + {"sha": "fc7cedfe9c6b2c0a40fd213cd18c0afc774b67fc", "html_url": "https://github.com/github/docs/commit/fc7cedfe9c6b2c0a40fd213cd18c0afc774b67fc", "commit": {"committer": {"date": "2026-02-13T16:44:32Z"}}} +] diff --git a/plugins/catalog/testdata/github-graphql-upcoming-changes-2706f417.json b/plugins/catalog/testdata/github-graphql-upcoming-changes-2706f417.json new file mode 100644 index 0000000..c125b9b --- /dev/null +++ b/plugins/catalog/testdata/github-graphql-upcoming-changes-2706f417.json @@ -0,0 +1,232 @@ +{ + "2026-04-01": [ + { + "location": "TeamRemoveRepositoryAuditEntry.userUrl", + "description": "

userUrl will be removed.

", + "reason": "

The GraphQL audit-log is deprecated. Please use the REST API instead.

", + "date": "2026-04-01", + "criticality": "breaking", + "owner": "audit_logs" + } + ], + "2026-01-01": [ + { + "location": "NotificationThread.subject", + "description": "

subject will be removed. Use the optionalSubject field instead.

", + "reason": "

Null values are possible for this field.

", + "date": "2026-01-01", + "criticality": "breaking", + "owner": "github/notifications" + } + ], + "2025-10-01": [ + { + "location": "SecurityAdvisory.cvss", + "description": "

cvss will be removed. New cvss_severities field will now contain both cvss_v3 and cvss_v4 properties.

", + "reason": "

cvss will be removed.

", + "date": "2025-10-01", + "criticality": "breaking", + "owner": "github/advisory-database" + } + ], + "2025-04-01": [ + { + "location": "User.viewerCanCreateProjects", + "description": "

viewerCanCreateProjects will be removed.

", + "reason": "

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/.

", + "date": "2025-04-01", + "criticality": "breaking", + "owner": "github/memex" + } + ], + "2025-01-01": [ + { + "location": "AddMobileDevicePublicKeyPayload.expiresAt", + "description": "

expiresAt will be removed. Do not rely on this field, it is currently set to a date far in the future if a device key is expirationless

", + "reason": "

We are deprecating expirations for mobile device keys used in mobile 2FA

", + "date": "2025-01-01", + "criticality": "breaking", + "owner": "chriskirkland" + } + ], + "2024-10-01": [ + { + "location": "Workflow.hasWorkflowDispatchTrigger", + "description": "

hasWorkflowDispatchTrigger will be removed. Use has_workflow_dispatch_trigger_for_branch(branch_ref) instead.

", + "reason": "

has_workflow_dispatch_trigger is being removed because it can be misleading and only checks a repository's default branch

", + "date": "2024-10-01", + "criticality": "breaking", + "owner": "stevepopovich" + } + ], + "2024-04-01": [ + { + "location": "TopicSuggestionDeclineReason.TOO_SPECIFIC", + "description": "

TOO_SPECIFIC will be removed.

", + "reason": "

Suggested topics are no longer supported

", + "date": "2024-04-01", + "criticality": "breaking", + "owner": "calvinchilds" + } + ], + "2023-10-01": [ + { + "location": "PullRequestReviewComment.position", + "description": "

position will be removed. Use the line and startLine fields instead, which are file line numbers instead of diff line numbers

", + "reason": "

We are phasing out diff-relative positioning for PR comments

", + "date": "2023-10-01", + "criticality": "breaking", + "owner": "aharpole" + } + ], + "2023-07-01": [ + { + "location": "ProjectV2ItemFieldGroup.field", + "description": "

field will be removed. Check out the ProjectV2ItemFieldGroup#groupByField API as an example for the more capable alternative.

", + "reason": "

The ProjectV2ItemFieldGroup#field API is deprecated in favour of the more capable ProjectV2ItemFieldGroup#groupByField API.

", + "date": "2023-07-01", + "criticality": "breaking", + "owner": "stevepopovich" + } + ], + "2023-04-01": [ + { + "location": "Repository.squashPrTitleUsedAsDefault", + "description": "

squashPrTitleUsedAsDefault will be removed. Use Repository.squashMergeCommitTitle instead.

", + "reason": "

squashPrTitleUsedAsDefault will be removed.

", + "date": "2023-04-01", + "criticality": "breaking", + "owner": "github/pull_requests" + } + ], + "2023-02-10": [ + { + "location": "PackageType.MAVEN", + "description": "

MAVEN will be removed.

", + "reason": "

MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2023-02-10", + "criticality": "breaking", + "owner": "ankitkaushal01" + } + ], + "2023-01-01": [ + { + "location": "ProjectV2View.visibleFields", + "description": "

visibleFields will be removed. Check out the ProjectV2View#fields API as an example for the more capable alternative.

", + "reason": "

The ProjectV2View#visibleFields API is deprecated in favour of the more capable ProjectV2View#fields API.

", + "date": "2023-01-01", + "criticality": "breaking", + "owner": "mattruggio" + } + ], + "2022-12-28": [ + { + "location": "PackageType.RUBYGEMS", + "description": "

RUBYGEMS will be removed.

", + "reason": "

RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2022-12-28", + "criticality": "breaking", + "owner": "ankitkaushal01" + } + ], + "2022-11-21": [ + { + "location": "PackageType.NUGET", + "description": "

NUGET will be removed.

", + "reason": "

NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2022-11-21", + "criticality": "breaking", + "owner": "s-anupam" + } + ], + "2022-10-01": [ + { + "location": "RemovePullRequestFromMergeQueueInput.branch", + "description": "

branch will be removed.

", + "reason": "

PRs are removed from the merge queue for the base branch, the branch argument is now a no-op

", + "date": "2022-10-01", + "criticality": "breaking", + "owner": "jhunschejones" + } + ], + "2022-07-01": [ + { + "location": "Query.sponsorables.dependencyEcosystem", + "description": "

dependencyEcosystem will be removed. Use the ecosystem argument instead.

", + "reason": "

The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.

", + "date": "2022-07-01", + "criticality": "breaking", + "owner": "cheshire137" + } + ], + "2021-10-01": [ + { + "location": "ReactionGroup.users", + "description": "

users will be removed. Use the reactors field instead.

", + "reason": "

Reactors can now be mannequins, bots, and organizations.

", + "date": "2021-10-01", + "criticality": "breaking", + "owner": "synthead" + } + ], + "2021-06-21": [ + { + "location": "PackageType.DOCKER", + "description": "

DOCKER will be removed.

", + "reason": "

DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2021-06-21", + "criticality": "breaking", + "owner": "reybard" + } + ], + "2021-01-01": [ + { + "location": "MergeStateStatus.DRAFT", + "description": "

DRAFT will be removed. Use PullRequest.isDraft instead.

", + "reason": "

DRAFT state will be removed from this enum and isDraft should be used instead

", + "date": "2021-01-01", + "criticality": "breaking", + "owner": "nplasterer" + } + ], + "2020-10-01": [ + { + "location": "Sponsorship.sponsor", + "description": "

sponsor will be removed. Use Sponsorship.sponsorEntity instead.

", + "reason": "

Sponsorship.sponsor will be removed.

", + "date": "2020-10-01", + "criticality": "breaking", + "owner": "nholden" + } + ], + "2020-04-01": [ + { + "location": "Sponsorship.maintainer", + "description": "

maintainer will be removed. Use Sponsorship.sponsorable instead.

", + "reason": "

Sponsorship.maintainer will be removed.

", + "date": "2020-04-01", + "criticality": "breaking", + "owner": "antn" + } + ], + "2020-01-01": [ + { + "location": "UnassignedEvent.user", + "description": "

user will be removed. Use the assignee field instead.

", + "reason": "

Assignees can now be mannequins.

", + "date": "2020-01-01", + "criticality": "breaking", + "owner": "tambling" + } + ], + "2019-04-01": [ + { + "location": "LegacyMigration.uploadUrlTemplate", + "description": "

uploadUrlTemplate will be removed. Use uploadUrl instead.

", + "reason": "

uploadUrlTemplate is being removed because it is not a standard URL and adds an extra user step.

", + "date": "2019-04-01", + "criticality": "breaking", + "owner": "tambling" + } + ] +} diff --git a/plugins/catalog/testdata/github-graphql-upcoming-changes-3a14e541.json b/plugins/catalog/testdata/github-graphql-upcoming-changes-3a14e541.json new file mode 100644 index 0000000..de52581 --- /dev/null +++ b/plugins/catalog/testdata/github-graphql-upcoming-changes-3a14e541.json @@ -0,0 +1,270 @@ +{ + "2027-01-01": [ + { + "location": "CheckAnnotation.databaseId", + "description": "

databaseId will be removed. Use fullDatabaseId instead.

", + "reason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers.

", + "date": "2027-01-01", + "criticality": "breaking", + "owner": "github/actions-persistence" + }, + { + "location": "Artifact.databaseId", + "description": "

databaseId will be removed. Use fullDatabaseId instead.

", + "reason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers.

", + "date": "2027-01-01", + "criticality": "breaking", + "owner": "github/actions-persistence" + } + ], + "2026-07-01": [ + { + "location": "Team.viewerSubscription", + "description": "

viewerSubscription will be removed.

", + "reason": "

Team.viewerSubscription will be removed. Team notifications subscriptions are being deprecated.

", + "date": "2026-07-01", + "criticality": "breaking", + "owner": "peter-evans" + } + ], + "2026-04-01": [ + { + "location": "TeamRemoveRepositoryAuditEntry.userUrl", + "description": "

userUrl will be removed.

", + "reason": "

The GraphQL audit-log is deprecated. Please use the REST API instead.

", + "date": "2026-04-01", + "criticality": "breaking", + "owner": "audit_logs" + } + ], + "2026-01-01": [ + { + "location": "NotificationThread.subject", + "description": "

subject will be removed. Use the optionalSubject field instead.

", + "reason": "

Null values are possible for this field.

", + "date": "2026-01-01", + "criticality": "breaking", + "owner": "github/notifications" + } + ], + "2025-10-01": [ + { + "location": "SecurityAdvisory.cvss", + "description": "

cvss will be removed. New cvss_severities field will now contain both cvss_v3 and cvss_v4 properties.

", + "reason": "

cvss will be removed.

", + "date": "2025-10-01", + "criticality": "breaking", + "owner": "github/advisory-database" + } + ], + "2025-04-01": [ + { + "location": "User.viewerCanCreateProjects", + "description": "

viewerCanCreateProjects will be removed.

", + "reason": "

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/.

", + "date": "2025-04-01", + "criticality": "breaking", + "owner": "github/memex" + } + ], + "2025-01-01": [ + { + "location": "AddMobileDevicePublicKeyPayload.expiresAt", + "description": "

expiresAt will be removed. Do not rely on this field, it is currently set to a date far in the future if a device key is expirationless

", + "reason": "

We are deprecating expirations for mobile device keys used in mobile 2FA

", + "date": "2025-01-01", + "criticality": "breaking", + "owner": "chriskirkland" + } + ], + "2024-10-01": [ + { + "location": "Workflow.hasWorkflowDispatchTrigger", + "description": "

hasWorkflowDispatchTrigger will be removed. Use has_workflow_dispatch_trigger_for_branch(branch_ref) instead.

", + "reason": "

has_workflow_dispatch_trigger is being removed because it can be misleading and only checks a repository's default branch

", + "date": "2024-10-01", + "criticality": "breaking", + "owner": "stevepopovich" + } + ], + "2024-07-01": [ + { + "location": "PullRequestReviewComment.databaseId", + "description": "

databaseId will be removed. Use fullDatabaseId instead.

", + "reason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "JanKoszewski" + } + ], + "2024-04-01": [ + { + "location": "TopicSuggestionDeclineReason.TOO_SPECIFIC", + "description": "

TOO_SPECIFIC will be removed.

", + "reason": "

Suggested topics are no longer supported

", + "date": "2024-04-01", + "criticality": "breaking", + "owner": "calvinchilds" + } + ], + "2023-10-01": [ + { + "location": "PullRequestReviewComment.position", + "description": "

position will be removed. Use the line and startLine fields instead, which are file line numbers instead of diff line numbers

", + "reason": "

We are phasing out diff-relative positioning for PR comments

", + "date": "2023-10-01", + "criticality": "breaking", + "owner": "aharpole" + } + ], + "2023-07-01": [ + { + "location": "ProjectV2ItemFieldGroup.field", + "description": "

field will be removed. Check out the ProjectV2ItemFieldGroup#groupByField API as an example for the more capable alternative.

", + "reason": "

The ProjectV2ItemFieldGroup#field API is deprecated in favour of the more capable ProjectV2ItemFieldGroup#groupByField API.

", + "date": "2023-07-01", + "criticality": "breaking", + "owner": "stevepopovich" + } + ], + "2023-04-01": [ + { + "location": "Repository.squashPrTitleUsedAsDefault", + "description": "

squashPrTitleUsedAsDefault will be removed. Use Repository.squashMergeCommitTitle instead.

", + "reason": "

squashPrTitleUsedAsDefault will be removed.

", + "date": "2023-04-01", + "criticality": "breaking", + "owner": "github/pull_requests" + } + ], + "2023-02-10": [ + { + "location": "PackageType.MAVEN", + "description": "

MAVEN will be removed.

", + "reason": "

MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2023-02-10", + "criticality": "breaking", + "owner": "ankitkaushal01" + } + ], + "2023-01-01": [ + { + "location": "ProjectV2View.visibleFields", + "description": "

visibleFields will be removed. Check out the ProjectV2View#fields API as an example for the more capable alternative.

", + "reason": "

The ProjectV2View#visibleFields API is deprecated in favour of the more capable ProjectV2View#fields API.

", + "date": "2023-01-01", + "criticality": "breaking", + "owner": "mattruggio" + } + ], + "2022-12-28": [ + { + "location": "PackageType.RUBYGEMS", + "description": "

RUBYGEMS will be removed.

", + "reason": "

RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2022-12-28", + "criticality": "breaking", + "owner": "ankitkaushal01" + } + ], + "2022-11-21": [ + { + "location": "PackageType.NUGET", + "description": "

NUGET will be removed.

", + "reason": "

NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2022-11-21", + "criticality": "breaking", + "owner": "s-anupam" + } + ], + "2022-10-01": [ + { + "location": "RemovePullRequestFromMergeQueueInput.branch", + "description": "

branch will be removed.

", + "reason": "

PRs are removed from the merge queue for the base branch, the branch argument is now a no-op

", + "date": "2022-10-01", + "criticality": "breaking", + "owner": "jhunschejones" + } + ], + "2022-07-01": [ + { + "location": "Query.sponsorables.dependencyEcosystem", + "description": "

dependencyEcosystem will be removed. Use the ecosystem argument instead.

", + "reason": "

The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.

", + "date": "2022-07-01", + "criticality": "breaking", + "owner": "cheshire137" + } + ], + "2021-10-01": [ + { + "location": "ReactionGroup.users", + "description": "

users will be removed. Use the reactors field instead.

", + "reason": "

Reactors can now be mannequins, bots, and organizations.

", + "date": "2021-10-01", + "criticality": "breaking", + "owner": "synthead" + } + ], + "2021-06-21": [ + { + "location": "PackageType.DOCKER", + "description": "

DOCKER will be removed.

", + "reason": "

DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2021-06-21", + "criticality": "breaking", + "owner": "reybard" + } + ], + "2021-01-01": [ + { + "location": "MergeStateStatus.DRAFT", + "description": "

DRAFT will be removed. Use PullRequest.isDraft instead.

", + "reason": "

DRAFT state will be removed from this enum and isDraft should be used instead

", + "date": "2021-01-01", + "criticality": "breaking", + "owner": "nplasterer" + } + ], + "2020-10-01": [ + { + "location": "Sponsorship.sponsor", + "description": "

sponsor will be removed. Use Sponsorship.sponsorEntity instead.

", + "reason": "

Sponsorship.sponsor will be removed.

", + "date": "2020-10-01", + "criticality": "breaking", + "owner": "nholden" + } + ], + "2020-04-01": [ + { + "location": "Sponsorship.maintainer", + "description": "

maintainer will be removed. Use Sponsorship.sponsorable instead.

", + "reason": "

Sponsorship.maintainer will be removed.

", + "date": "2020-04-01", + "criticality": "breaking", + "owner": "antn" + } + ], + "2020-01-01": [ + { + "location": "UnassignedEvent.user", + "description": "

user will be removed. Use the assignee field instead.

", + "reason": "

Assignees can now be mannequins.

", + "date": "2020-01-01", + "criticality": "breaking", + "owner": "tambling" + } + ], + "2019-04-01": [ + { + "location": "LegacyMigration.uploadUrlTemplate", + "description": "

uploadUrlTemplate will be removed. Use uploadUrl instead.

", + "reason": "

uploadUrlTemplate is being removed because it is not a standard URL and adds an extra user step.

", + "date": "2019-04-01", + "criticality": "breaking", + "owner": "tambling" + } + ] +} diff --git a/plugins/catalog/testdata/github-graphql-upcoming-changes-54c26c43.json b/plugins/catalog/testdata/github-graphql-upcoming-changes-54c26c43.json new file mode 100644 index 0000000..05022ae --- /dev/null +++ b/plugins/catalog/testdata/github-graphql-upcoming-changes-54c26c43.json @@ -0,0 +1,370 @@ +{ + "2026-04-01": [ + { + "location": "TeamRemoveRepositoryAuditEntry.userUrl", + "description": "

userUrl will be removed.

", + "reason": "

The GraphQL audit-log is deprecated. Please use the REST API instead.

", + "date": "2026-04-01", + "criticality": "breaking", + "owner": "audit_logs" + } + ], + "2026-01-01": [ + { + "location": "NotificationThread.subject", + "description": "

subject will be removed. Use the optionalSubject field instead.

", + "reason": "

Null values are possible for this field.

", + "date": "2026-01-01", + "criticality": "breaking", + "owner": "github/notifications" + } + ], + "2025-10-01": [ + { + "location": "SecurityAdvisory.cvss", + "description": "

cvss will be removed. New cvss_severities field will now contain both cvss_v3 and cvss_v4 properties.

", + "reason": "

cvss will be removed.

", + "date": "2025-10-01", + "criticality": "breaking", + "owner": "github/advisory-database" + } + ], + "2025-04-01": [ + { + "location": "User.viewerCanCreateProjects", + "description": "

viewerCanCreateProjects will be removed.

", + "reason": "

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/.

", + "date": "2025-04-01", + "criticality": "breaking", + "owner": "github/memex" + } + ], + "2025-01-01": [ + { + "location": "AddMobileDevicePublicKeyPayload.expiresAt", + "description": "

expiresAt will be removed. Do not rely on this field, it is currently set to a date far in the future if a device key is expirationless

", + "reason": "

We are deprecating expirations for mobile device keys used in mobile 2FA

", + "date": "2025-01-01", + "criticality": "breaking", + "owner": "chriskirkland" + } + ], + "2024-10-01": [ + { + "location": "Workflow.hasWorkflowDispatchTrigger", + "description": "

hasWorkflowDispatchTrigger will be removed. Use has_workflow_dispatch_trigger_for_branch(branch_ref) instead.

", + "reason": "

has_workflow_dispatch_trigger is being removed because it can be misleading and only checks a repository's default branch

", + "date": "2024-10-01", + "criticality": "breaking", + "owner": "stevepopovich" + } + ], + "2024-07-01": [ + { + "location": "TeamDiscussion.viewerCanPin", + "description": "

viewerCanPin will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "TeamDiscussion.url", + "description": "

url will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "TeamDiscussion.title", + "description": "

title will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "TeamDiscussion.team", + "description": "

team will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "TeamDiscussion.resourcePath", + "description": "

resourcePath will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "TeamDiscussion.number", + "description": "

number will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "TeamDiscussion.isPrivate", + "description": "

isPrivate will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "TeamDiscussion.isPinned", + "description": "

isPinned will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "TeamDiscussion.commentsUrl", + "description": "

commentsUrl will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "TeamDiscussion.commentsResourcePath", + "description": "

commentsResourcePath will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "TeamDiscussion.bodyVersion", + "description": "

bodyVersion will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "TeamDiscussion.authorAssociation", + "description": "

authorAssociation will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "CreateTeamDiscussionPayload.teamDiscussion", + "description": "

teamDiscussion will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "CreateTeamDiscussionInput.title", + "description": "

title will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "CreateTeamDiscussionInput.teamId", + "description": "

teamId will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "CreateTeamDiscussionInput.private", + "description": "

private will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + }, + { + "location": "CreateTeamDiscussionInput.body", + "description": "

body will be removed. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement.

", + "reason": "

The Team Discussions feature is deprecated in favor of Organization Discussions.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "deborah-digges" + } + ], + "2024-04-01": [ + { + "location": "TopicSuggestionDeclineReason.TOO_SPECIFIC", + "description": "

TOO_SPECIFIC will be removed.

", + "reason": "

Suggested topics are no longer supported

", + "date": "2024-04-01", + "criticality": "breaking", + "owner": "calvinchilds" + } + ], + "2023-10-01": [ + { + "location": "PullRequestReviewComment.position", + "description": "

position will be removed. Use the line and startLine fields instead, which are file line numbers instead of diff line numbers

", + "reason": "

We are phasing out diff-relative positioning for PR comments

", + "date": "2023-10-01", + "criticality": "breaking", + "owner": "aharpole" + } + ], + "2023-07-01": [ + { + "location": "ProjectV2ItemFieldGroup.field", + "description": "

field will be removed. Check out the ProjectV2ItemFieldGroup#groupByField API as an example for the more capable alternative.

", + "reason": "

The ProjectV2ItemFieldGroup#field API is deprecated in favour of the more capable ProjectV2ItemFieldGroup#groupByField API.

", + "date": "2023-07-01", + "criticality": "breaking", + "owner": "stevepopovich" + } + ], + "2023-04-01": [ + { + "location": "Repository.squashPrTitleUsedAsDefault", + "description": "

squashPrTitleUsedAsDefault will be removed. Use Repository.squashMergeCommitTitle instead.

", + "reason": "

squashPrTitleUsedAsDefault will be removed.

", + "date": "2023-04-01", + "criticality": "breaking", + "owner": "github/pull_requests" + } + ], + "2023-02-10": [ + { + "location": "PackageType.MAVEN", + "description": "

MAVEN will be removed.

", + "reason": "

MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2023-02-10", + "criticality": "breaking", + "owner": "ankitkaushal01" + } + ], + "2023-01-01": [ + { + "location": "ProjectV2View.visibleFields", + "description": "

visibleFields will be removed. Check out the ProjectV2View#fields API as an example for the more capable alternative.

", + "reason": "

The ProjectV2View#visibleFields API is deprecated in favour of the more capable ProjectV2View#fields API.

", + "date": "2023-01-01", + "criticality": "breaking", + "owner": "mattruggio" + } + ], + "2022-12-28": [ + { + "location": "PackageType.RUBYGEMS", + "description": "

RUBYGEMS will be removed.

", + "reason": "

RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2022-12-28", + "criticality": "breaking", + "owner": "ankitkaushal01" + } + ], + "2022-11-21": [ + { + "location": "PackageType.NUGET", + "description": "

NUGET will be removed.

", + "reason": "

NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2022-11-21", + "criticality": "breaking", + "owner": "s-anupam" + } + ], + "2022-10-01": [ + { + "location": "RemovePullRequestFromMergeQueueInput.branch", + "description": "

branch will be removed.

", + "reason": "

PRs are removed from the merge queue for the base branch, the branch argument is now a no-op

", + "date": "2022-10-01", + "criticality": "breaking", + "owner": "jhunschejones" + } + ], + "2022-07-01": [ + { + "location": "Query.sponsorables.dependencyEcosystem", + "description": "

dependencyEcosystem will be removed. Use the ecosystem argument instead.

", + "reason": "

The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.

", + "date": "2022-07-01", + "criticality": "breaking", + "owner": "cheshire137" + } + ], + "2021-10-01": [ + { + "location": "ReactionGroup.users", + "description": "

users will be removed. Use the reactors field instead.

", + "reason": "

Reactors can now be mannequins, bots, and organizations.

", + "date": "2021-10-01", + "criticality": "breaking", + "owner": "synthead" + } + ], + "2021-06-21": [ + { + "location": "PackageType.DOCKER", + "description": "

DOCKER will be removed.

", + "reason": "

DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2021-06-21", + "criticality": "breaking", + "owner": "reybard" + } + ], + "2021-01-01": [ + { + "location": "MergeStateStatus.DRAFT", + "description": "

DRAFT will be removed. Use PullRequest.isDraft instead.

", + "reason": "

DRAFT state will be removed from this enum and isDraft should be used instead

", + "date": "2021-01-01", + "criticality": "breaking", + "owner": "nplasterer" + } + ], + "2020-10-01": [ + { + "location": "Sponsorship.sponsor", + "description": "

sponsor will be removed. Use Sponsorship.sponsorEntity instead.

", + "reason": "

Sponsorship.sponsor will be removed.

", + "date": "2020-10-01", + "criticality": "breaking", + "owner": "nholden" + } + ], + "2020-04-01": [ + { + "location": "Sponsorship.maintainer", + "description": "

maintainer will be removed. Use Sponsorship.sponsorable instead.

", + "reason": "

Sponsorship.maintainer will be removed.

", + "date": "2020-04-01", + "criticality": "breaking", + "owner": "antn" + } + ], + "2020-01-01": [ + { + "location": "UnassignedEvent.user", + "description": "

user will be removed. Use the assignee field instead.

", + "reason": "

Assignees can now be mannequins.

", + "date": "2020-01-01", + "criticality": "breaking", + "owner": "tambling" + } + ], + "2019-04-01": [ + { + "location": "LegacyMigration.uploadUrlTemplate", + "description": "

uploadUrlTemplate will be removed. Use uploadUrl instead.

", + "reason": "

uploadUrlTemplate is being removed because it is not a standard URL and adds an extra user step.

", + "date": "2019-04-01", + "criticality": "breaking", + "owner": "tambling" + } + ] +} diff --git a/plugins/catalog/testdata/github-graphql-upcoming-changes-a934f06d.json b/plugins/catalog/testdata/github-graphql-upcoming-changes-a934f06d.json new file mode 100644 index 0000000..d860287 --- /dev/null +++ b/plugins/catalog/testdata/github-graphql-upcoming-changes-a934f06d.json @@ -0,0 +1,280 @@ +{ + "2027-01-01": [ + { + "location": "CheckAnnotation.databaseId", + "description": "

databaseId will be removed. Use fullDatabaseId instead.

", + "reason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers.

", + "date": "2027-01-01", + "criticality": "breaking", + "owner": "github/actions-persistence" + }, + { + "location": "Artifact.databaseId", + "description": "

databaseId will be removed. Use fullDatabaseId instead.

", + "reason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers.

", + "date": "2027-01-01", + "criticality": "breaking", + "owner": "github/actions-persistence" + } + ], + "2026-10-01": [ + { + "location": "User.viewerRelevantRepositories", + "description": "

viewerRelevantRepositories will be removed. Use viewerCopilotChatRepositorySuggestions instead.

", + "reason": "

viewerRelevantRepositories has been renamed to viewerCopilotChatRepositorySuggestions.

", + "date": "2026-10-01", + "criticality": "breaking", + "owner": "github/client-apps-platform" + } + ], + "2026-07-01": [ + { + "location": "Team.viewerSubscription", + "description": "

viewerSubscription will be removed.

", + "reason": "

Team.viewerSubscription will be removed. Team notifications subscriptions are being deprecated.

", + "date": "2026-07-01", + "criticality": "breaking", + "owner": "peter-evans" + } + ], + "2026-04-01": [ + { + "location": "TeamRemoveRepositoryAuditEntry.userUrl", + "description": "

userUrl will be removed.

", + "reason": "

The GraphQL audit-log is deprecated. Please use the REST API instead.

", + "date": "2026-04-01", + "criticality": "breaking", + "owner": "audit_logs" + } + ], + "2026-01-01": [ + { + "location": "NotificationThread.subject", + "description": "

subject will be removed. Use the optionalSubject field instead.

", + "reason": "

Null values are possible for this field.

", + "date": "2026-01-01", + "criticality": "breaking", + "owner": "github/notifications" + } + ], + "2025-10-01": [ + { + "location": "SecurityAdvisory.cvss", + "description": "

cvss will be removed. New cvss_severities field will now contain both cvss_v3 and cvss_v4 properties.

", + "reason": "

cvss will be removed.

", + "date": "2025-10-01", + "criticality": "breaking", + "owner": "github/advisory-database" + } + ], + "2025-04-01": [ + { + "location": "User.viewerCanCreateProjects", + "description": "

viewerCanCreateProjects will be removed.

", + "reason": "

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/.

", + "date": "2025-04-01", + "criticality": "breaking", + "owner": "github/memex" + } + ], + "2025-01-01": [ + { + "location": "AddMobileDevicePublicKeyPayload.expiresAt", + "description": "

expiresAt will be removed. Do not rely on this field, it is currently set to a date far in the future if a device key is expirationless

", + "reason": "

We are deprecating expirations for mobile device keys used in mobile 2FA

", + "date": "2025-01-01", + "criticality": "breaking", + "owner": "chriskirkland" + } + ], + "2024-10-01": [ + { + "location": "Workflow.hasWorkflowDispatchTrigger", + "description": "

hasWorkflowDispatchTrigger will be removed. Use has_workflow_dispatch_trigger_for_branch(branch_ref) instead.

", + "reason": "

has_workflow_dispatch_trigger is being removed because it can be misleading and only checks a repository's default branch

", + "date": "2024-10-01", + "criticality": "breaking", + "owner": "stevepopovich" + } + ], + "2024-07-01": [ + { + "location": "PullRequestReviewComment.databaseId", + "description": "

databaseId will be removed. Use fullDatabaseId instead.

", + "reason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "JanKoszewski" + } + ], + "2024-04-01": [ + { + "location": "TopicSuggestionDeclineReason.TOO_SPECIFIC", + "description": "

TOO_SPECIFIC will be removed.

", + "reason": "

Suggested topics are no longer supported

", + "date": "2024-04-01", + "criticality": "breaking", + "owner": "calvinchilds" + } + ], + "2023-10-01": [ + { + "location": "PullRequestReviewComment.position", + "description": "

position will be removed. Use the line and startLine fields instead, which are file line numbers instead of diff line numbers

", + "reason": "

We are phasing out diff-relative positioning for PR comments

", + "date": "2023-10-01", + "criticality": "breaking", + "owner": "aharpole" + } + ], + "2023-07-01": [ + { + "location": "ProjectV2ItemFieldGroup.field", + "description": "

field will be removed. Check out the ProjectV2ItemFieldGroup#groupByField API as an example for the more capable alternative.

", + "reason": "

The ProjectV2ItemFieldGroup#field API is deprecated in favour of the more capable ProjectV2ItemFieldGroup#groupByField API.

", + "date": "2023-07-01", + "criticality": "breaking", + "owner": "stevepopovich" + } + ], + "2023-04-01": [ + { + "location": "Repository.squashPrTitleUsedAsDefault", + "description": "

squashPrTitleUsedAsDefault will be removed. Use Repository.squashMergeCommitTitle instead.

", + "reason": "

squashPrTitleUsedAsDefault will be removed.

", + "date": "2023-04-01", + "criticality": "breaking", + "owner": "github/pull_requests" + } + ], + "2023-02-10": [ + { + "location": "PackageType.MAVEN", + "description": "

MAVEN will be removed.

", + "reason": "

MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2023-02-10", + "criticality": "breaking", + "owner": "ankitkaushal01" + } + ], + "2023-01-01": [ + { + "location": "ProjectV2View.visibleFields", + "description": "

visibleFields will be removed. Check out the ProjectV2View#fields API as an example for the more capable alternative.

", + "reason": "

The ProjectV2View#visibleFields API is deprecated in favour of the more capable ProjectV2View#fields API.

", + "date": "2023-01-01", + "criticality": "breaking", + "owner": "mattruggio" + } + ], + "2022-12-28": [ + { + "location": "PackageType.RUBYGEMS", + "description": "

RUBYGEMS will be removed.

", + "reason": "

RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2022-12-28", + "criticality": "breaking", + "owner": "ankitkaushal01" + } + ], + "2022-11-21": [ + { + "location": "PackageType.NUGET", + "description": "

NUGET will be removed.

", + "reason": "

NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2022-11-21", + "criticality": "breaking", + "owner": "s-anupam" + } + ], + "2022-10-01": [ + { + "location": "RemovePullRequestFromMergeQueueInput.branch", + "description": "

branch will be removed.

", + "reason": "

PRs are removed from the merge queue for the base branch, the branch argument is now a no-op

", + "date": "2022-10-01", + "criticality": "breaking", + "owner": "jhunschejones" + } + ], + "2022-07-01": [ + { + "location": "Query.sponsorables.dependencyEcosystem", + "description": "

dependencyEcosystem will be removed. Use the ecosystem argument instead.

", + "reason": "

The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.

", + "date": "2022-07-01", + "criticality": "breaking", + "owner": "cheshire137" + } + ], + "2021-10-01": [ + { + "location": "ReactionGroup.users", + "description": "

users will be removed. Use the reactors field instead.

", + "reason": "

Reactors can now be mannequins, bots, and organizations.

", + "date": "2021-10-01", + "criticality": "breaking", + "owner": "synthead" + } + ], + "2021-06-21": [ + { + "location": "PackageType.DOCKER", + "description": "

DOCKER will be removed.

", + "reason": "

DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2021-06-21", + "criticality": "breaking", + "owner": "reybard" + } + ], + "2021-01-01": [ + { + "location": "MergeStateStatus.DRAFT", + "description": "

DRAFT will be removed. Use PullRequest.isDraft instead.

", + "reason": "

DRAFT state will be removed from this enum and isDraft should be used instead

", + "date": "2021-01-01", + "criticality": "breaking", + "owner": "nplasterer" + } + ], + "2020-10-01": [ + { + "location": "Sponsorship.sponsor", + "description": "

sponsor will be removed. Use Sponsorship.sponsorEntity instead.

", + "reason": "

Sponsorship.sponsor will be removed.

", + "date": "2020-10-01", + "criticality": "breaking", + "owner": "nholden" + } + ], + "2020-04-01": [ + { + "location": "Sponsorship.maintainer", + "description": "

maintainer will be removed. Use Sponsorship.sponsorable instead.

", + "reason": "

Sponsorship.maintainer will be removed.

", + "date": "2020-04-01", + "criticality": "breaking", + "owner": "antn" + } + ], + "2020-01-01": [ + { + "location": "UnassignedEvent.user", + "description": "

user will be removed. Use the assignee field instead.

", + "reason": "

Assignees can now be mannequins.

", + "date": "2020-01-01", + "criticality": "breaking", + "owner": "tambling" + } + ], + "2019-04-01": [ + { + "location": "LegacyMigration.uploadUrlTemplate", + "description": "

uploadUrlTemplate will be removed. Use uploadUrl instead.

", + "reason": "

uploadUrlTemplate is being removed because it is not a standard URL and adds an extra user step.

", + "date": "2019-04-01", + "criticality": "breaking", + "owner": "tambling" + } + ] +} diff --git a/plugins/catalog/testdata/github-graphql-upcoming-changes-c5738e58.json b/plugins/catalog/testdata/github-graphql-upcoming-changes-c5738e58.json new file mode 100644 index 0000000..41679ff --- /dev/null +++ b/plugins/catalog/testdata/github-graphql-upcoming-changes-c5738e58.json @@ -0,0 +1,288 @@ +{ + "2027-01-01": [ + { + "location": "CheckAnnotation.databaseId", + "description": "

databaseId will be removed. Use fullDatabaseId instead.

", + "reason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers.

", + "date": "2027-01-01", + "criticality": "breaking", + "owner": "github/actions-persistence" + }, + { + "location": "Artifact.databaseId", + "description": "

databaseId will be removed. Use fullDatabaseId instead.

", + "reason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers.

", + "date": "2027-01-01", + "criticality": "breaking", + "owner": "github/actions-persistence" + } + ], + "2026-10-01": [ + { + "location": "User.viewerRelevantRepositories", + "description": "

viewerRelevantRepositories will be removed. Use viewerCopilotChatRepositorySuggestions instead.

", + "reason": "

viewerRelevantRepositories has been renamed to viewerCopilotChatRepositorySuggestions.

", + "date": "2026-10-01", + "criticality": "breaking", + "owner": "github/client-apps-platform" + }, + { + "location": "CopilotAgentTask.type", + "description": "

type will be removed. Use codingAgentFilter and codingAgentTypeFilter instead.

", + "reason": "

type will be removed.

", + "date": "2026-10-01", + "criticality": "breaking", + "owner": "github/copilot-mission-control" + } + ], + "2026-07-01": [ + { + "location": "Team.viewerSubscription", + "description": "

viewerSubscription will be removed.

", + "reason": "

Team.viewerSubscription will be removed. Team notifications subscriptions are being deprecated.

", + "date": "2026-07-01", + "criticality": "breaking", + "owner": "peter-evans" + } + ], + "2026-04-01": [ + { + "location": "TeamRemoveRepositoryAuditEntry.userUrl", + "description": "

userUrl will be removed.

", + "reason": "

The GraphQL audit-log is deprecated. Please use the REST API instead.

", + "date": "2026-04-01", + "criticality": "breaking", + "owner": "audit_logs" + } + ], + "2026-01-01": [ + { + "location": "NotificationThread.subject", + "description": "

subject will be removed. Use the optionalSubject field instead.

", + "reason": "

Null values are possible for this field.

", + "date": "2026-01-01", + "criticality": "breaking", + "owner": "github/notifications" + } + ], + "2025-10-01": [ + { + "location": "SecurityAdvisory.cvss", + "description": "

cvss will be removed. New cvss_severities field will now contain both cvss_v3 and cvss_v4 properties.

", + "reason": "

cvss will be removed.

", + "date": "2025-10-01", + "criticality": "breaking", + "owner": "github/advisory-database" + } + ], + "2025-04-01": [ + { + "location": "User.viewerCanCreateProjects", + "description": "

viewerCanCreateProjects will be removed.

", + "reason": "

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/.

", + "date": "2025-04-01", + "criticality": "breaking", + "owner": "github/memex" + } + ], + "2025-01-01": [ + { + "location": "AddMobileDevicePublicKeyPayload.expiresAt", + "description": "

expiresAt will be removed. Do not rely on this field, it is currently set to a date far in the future if a device key is expirationless

", + "reason": "

We are deprecating expirations for mobile device keys used in mobile 2FA

", + "date": "2025-01-01", + "criticality": "breaking", + "owner": "chriskirkland" + } + ], + "2024-10-01": [ + { + "location": "Workflow.hasWorkflowDispatchTrigger", + "description": "

hasWorkflowDispatchTrigger will be removed. Use has_workflow_dispatch_trigger_for_branch(branch_ref) instead.

", + "reason": "

has_workflow_dispatch_trigger is being removed because it can be misleading and only checks a repository's default branch

", + "date": "2024-10-01", + "criticality": "breaking", + "owner": "stevepopovich" + } + ], + "2024-07-01": [ + { + "location": "PullRequestReviewComment.databaseId", + "description": "

databaseId will be removed. Use fullDatabaseId instead.

", + "reason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "JanKoszewski" + } + ], + "2024-04-01": [ + { + "location": "TopicSuggestionDeclineReason.TOO_SPECIFIC", + "description": "

TOO_SPECIFIC will be removed.

", + "reason": "

Suggested topics are no longer supported

", + "date": "2024-04-01", + "criticality": "breaking", + "owner": "calvinchilds" + } + ], + "2023-10-01": [ + { + "location": "PullRequestReviewComment.position", + "description": "

position will be removed. Use the line and startLine fields instead, which are file line numbers instead of diff line numbers

", + "reason": "

We are phasing out diff-relative positioning for PR comments

", + "date": "2023-10-01", + "criticality": "breaking", + "owner": "aharpole" + } + ], + "2023-07-01": [ + { + "location": "ProjectV2ItemFieldGroup.field", + "description": "

field will be removed. Check out the ProjectV2ItemFieldGroup#groupByField API as an example for the more capable alternative.

", + "reason": "

The ProjectV2ItemFieldGroup#field API is deprecated in favour of the more capable ProjectV2ItemFieldGroup#groupByField API.

", + "date": "2023-07-01", + "criticality": "breaking", + "owner": "stevepopovich" + } + ], + "2023-04-01": [ + { + "location": "Repository.squashPrTitleUsedAsDefault", + "description": "

squashPrTitleUsedAsDefault will be removed. Use Repository.squashMergeCommitTitle instead.

", + "reason": "

squashPrTitleUsedAsDefault will be removed.

", + "date": "2023-04-01", + "criticality": "breaking", + "owner": "github/pull_requests" + } + ], + "2023-02-10": [ + { + "location": "PackageType.MAVEN", + "description": "

MAVEN will be removed.

", + "reason": "

MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2023-02-10", + "criticality": "breaking", + "owner": "ankitkaushal01" + } + ], + "2023-01-01": [ + { + "location": "ProjectV2View.visibleFields", + "description": "

visibleFields will be removed. Check out the ProjectV2View#fields API as an example for the more capable alternative.

", + "reason": "

The ProjectV2View#visibleFields API is deprecated in favour of the more capable ProjectV2View#fields API.

", + "date": "2023-01-01", + "criticality": "breaking", + "owner": "mattruggio" + } + ], + "2022-12-28": [ + { + "location": "PackageType.RUBYGEMS", + "description": "

RUBYGEMS will be removed.

", + "reason": "

RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2022-12-28", + "criticality": "breaking", + "owner": "ankitkaushal01" + } + ], + "2022-11-21": [ + { + "location": "PackageType.NUGET", + "description": "

NUGET will be removed.

", + "reason": "

NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2022-11-21", + "criticality": "breaking", + "owner": "s-anupam" + } + ], + "2022-10-01": [ + { + "location": "RemovePullRequestFromMergeQueueInput.branch", + "description": "

branch will be removed.

", + "reason": "

PRs are removed from the merge queue for the base branch, the branch argument is now a no-op

", + "date": "2022-10-01", + "criticality": "breaking", + "owner": "jhunschejones" + } + ], + "2022-07-01": [ + { + "location": "Query.sponsorables.dependencyEcosystem", + "description": "

dependencyEcosystem will be removed. Use the ecosystem argument instead.

", + "reason": "

The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.

", + "date": "2022-07-01", + "criticality": "breaking", + "owner": "cheshire137" + } + ], + "2021-10-01": [ + { + "location": "ReactionGroup.users", + "description": "

users will be removed. Use the reactors field instead.

", + "reason": "

Reactors can now be mannequins, bots, and organizations.

", + "date": "2021-10-01", + "criticality": "breaking", + "owner": "synthead" + } + ], + "2021-06-21": [ + { + "location": "PackageType.DOCKER", + "description": "

DOCKER will be removed.

", + "reason": "

DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2021-06-21", + "criticality": "breaking", + "owner": "reybard" + } + ], + "2021-01-01": [ + { + "location": "MergeStateStatus.DRAFT", + "description": "

DRAFT will be removed. Use PullRequest.isDraft instead.

", + "reason": "

DRAFT state will be removed from this enum and isDraft should be used instead

", + "date": "2021-01-01", + "criticality": "breaking", + "owner": "nplasterer" + } + ], + "2020-10-01": [ + { + "location": "Sponsorship.sponsor", + "description": "

sponsor will be removed. Use Sponsorship.sponsorEntity instead.

", + "reason": "

Sponsorship.sponsor will be removed.

", + "date": "2020-10-01", + "criticality": "breaking", + "owner": "nholden" + } + ], + "2020-04-01": [ + { + "location": "Sponsorship.maintainer", + "description": "

maintainer will be removed. Use Sponsorship.sponsorable instead.

", + "reason": "

Sponsorship.maintainer will be removed.

", + "date": "2020-04-01", + "criticality": "breaking", + "owner": "antn" + } + ], + "2020-01-01": [ + { + "location": "UnassignedEvent.user", + "description": "

user will be removed. Use the assignee field instead.

", + "reason": "

Assignees can now be mannequins.

", + "date": "2020-01-01", + "criticality": "breaking", + "owner": "tambling" + } + ], + "2019-04-01": [ + { + "location": "LegacyMigration.uploadUrlTemplate", + "description": "

uploadUrlTemplate will be removed. Use uploadUrl instead.

", + "reason": "

uploadUrlTemplate is being removed because it is not a standard URL and adds an extra user step.

", + "date": "2019-04-01", + "criticality": "breaking", + "owner": "tambling" + } + ] +} diff --git a/plugins/catalog/testdata/github-graphql-upcoming-changes-fc26275f.json b/plugins/catalog/testdata/github-graphql-upcoming-changes-fc26275f.json new file mode 100644 index 0000000..c125b9b --- /dev/null +++ b/plugins/catalog/testdata/github-graphql-upcoming-changes-fc26275f.json @@ -0,0 +1,232 @@ +{ + "2026-04-01": [ + { + "location": "TeamRemoveRepositoryAuditEntry.userUrl", + "description": "

userUrl will be removed.

", + "reason": "

The GraphQL audit-log is deprecated. Please use the REST API instead.

", + "date": "2026-04-01", + "criticality": "breaking", + "owner": "audit_logs" + } + ], + "2026-01-01": [ + { + "location": "NotificationThread.subject", + "description": "

subject will be removed. Use the optionalSubject field instead.

", + "reason": "

Null values are possible for this field.

", + "date": "2026-01-01", + "criticality": "breaking", + "owner": "github/notifications" + } + ], + "2025-10-01": [ + { + "location": "SecurityAdvisory.cvss", + "description": "

cvss will be removed. New cvss_severities field will now contain both cvss_v3 and cvss_v4 properties.

", + "reason": "

cvss will be removed.

", + "date": "2025-10-01", + "criticality": "breaking", + "owner": "github/advisory-database" + } + ], + "2025-04-01": [ + { + "location": "User.viewerCanCreateProjects", + "description": "

viewerCanCreateProjects will be removed.

", + "reason": "

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/.

", + "date": "2025-04-01", + "criticality": "breaking", + "owner": "github/memex" + } + ], + "2025-01-01": [ + { + "location": "AddMobileDevicePublicKeyPayload.expiresAt", + "description": "

expiresAt will be removed. Do not rely on this field, it is currently set to a date far in the future if a device key is expirationless

", + "reason": "

We are deprecating expirations for mobile device keys used in mobile 2FA

", + "date": "2025-01-01", + "criticality": "breaking", + "owner": "chriskirkland" + } + ], + "2024-10-01": [ + { + "location": "Workflow.hasWorkflowDispatchTrigger", + "description": "

hasWorkflowDispatchTrigger will be removed. Use has_workflow_dispatch_trigger_for_branch(branch_ref) instead.

", + "reason": "

has_workflow_dispatch_trigger is being removed because it can be misleading and only checks a repository's default branch

", + "date": "2024-10-01", + "criticality": "breaking", + "owner": "stevepopovich" + } + ], + "2024-04-01": [ + { + "location": "TopicSuggestionDeclineReason.TOO_SPECIFIC", + "description": "

TOO_SPECIFIC will be removed.

", + "reason": "

Suggested topics are no longer supported

", + "date": "2024-04-01", + "criticality": "breaking", + "owner": "calvinchilds" + } + ], + "2023-10-01": [ + { + "location": "PullRequestReviewComment.position", + "description": "

position will be removed. Use the line and startLine fields instead, which are file line numbers instead of diff line numbers

", + "reason": "

We are phasing out diff-relative positioning for PR comments

", + "date": "2023-10-01", + "criticality": "breaking", + "owner": "aharpole" + } + ], + "2023-07-01": [ + { + "location": "ProjectV2ItemFieldGroup.field", + "description": "

field will be removed. Check out the ProjectV2ItemFieldGroup#groupByField API as an example for the more capable alternative.

", + "reason": "

The ProjectV2ItemFieldGroup#field API is deprecated in favour of the more capable ProjectV2ItemFieldGroup#groupByField API.

", + "date": "2023-07-01", + "criticality": "breaking", + "owner": "stevepopovich" + } + ], + "2023-04-01": [ + { + "location": "Repository.squashPrTitleUsedAsDefault", + "description": "

squashPrTitleUsedAsDefault will be removed. Use Repository.squashMergeCommitTitle instead.

", + "reason": "

squashPrTitleUsedAsDefault will be removed.

", + "date": "2023-04-01", + "criticality": "breaking", + "owner": "github/pull_requests" + } + ], + "2023-02-10": [ + { + "location": "PackageType.MAVEN", + "description": "

MAVEN will be removed.

", + "reason": "

MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2023-02-10", + "criticality": "breaking", + "owner": "ankitkaushal01" + } + ], + "2023-01-01": [ + { + "location": "ProjectV2View.visibleFields", + "description": "

visibleFields will be removed. Check out the ProjectV2View#fields API as an example for the more capable alternative.

", + "reason": "

The ProjectV2View#visibleFields API is deprecated in favour of the more capable ProjectV2View#fields API.

", + "date": "2023-01-01", + "criticality": "breaking", + "owner": "mattruggio" + } + ], + "2022-12-28": [ + { + "location": "PackageType.RUBYGEMS", + "description": "

RUBYGEMS will be removed.

", + "reason": "

RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2022-12-28", + "criticality": "breaking", + "owner": "ankitkaushal01" + } + ], + "2022-11-21": [ + { + "location": "PackageType.NUGET", + "description": "

NUGET will be removed.

", + "reason": "

NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2022-11-21", + "criticality": "breaking", + "owner": "s-anupam" + } + ], + "2022-10-01": [ + { + "location": "RemovePullRequestFromMergeQueueInput.branch", + "description": "

branch will be removed.

", + "reason": "

PRs are removed from the merge queue for the base branch, the branch argument is now a no-op

", + "date": "2022-10-01", + "criticality": "breaking", + "owner": "jhunschejones" + } + ], + "2022-07-01": [ + { + "location": "Query.sponsorables.dependencyEcosystem", + "description": "

dependencyEcosystem will be removed. Use the ecosystem argument instead.

", + "reason": "

The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.

", + "date": "2022-07-01", + "criticality": "breaking", + "owner": "cheshire137" + } + ], + "2021-10-01": [ + { + "location": "ReactionGroup.users", + "description": "

users will be removed. Use the reactors field instead.

", + "reason": "

Reactors can now be mannequins, bots, and organizations.

", + "date": "2021-10-01", + "criticality": "breaking", + "owner": "synthead" + } + ], + "2021-06-21": [ + { + "location": "PackageType.DOCKER", + "description": "

DOCKER will be removed.

", + "reason": "

DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2021-06-21", + "criticality": "breaking", + "owner": "reybard" + } + ], + "2021-01-01": [ + { + "location": "MergeStateStatus.DRAFT", + "description": "

DRAFT will be removed. Use PullRequest.isDraft instead.

", + "reason": "

DRAFT state will be removed from this enum and isDraft should be used instead

", + "date": "2021-01-01", + "criticality": "breaking", + "owner": "nplasterer" + } + ], + "2020-10-01": [ + { + "location": "Sponsorship.sponsor", + "description": "

sponsor will be removed. Use Sponsorship.sponsorEntity instead.

", + "reason": "

Sponsorship.sponsor will be removed.

", + "date": "2020-10-01", + "criticality": "breaking", + "owner": "nholden" + } + ], + "2020-04-01": [ + { + "location": "Sponsorship.maintainer", + "description": "

maintainer will be removed. Use Sponsorship.sponsorable instead.

", + "reason": "

Sponsorship.maintainer will be removed.

", + "date": "2020-04-01", + "criticality": "breaking", + "owner": "antn" + } + ], + "2020-01-01": [ + { + "location": "UnassignedEvent.user", + "description": "

user will be removed. Use the assignee field instead.

", + "reason": "

Assignees can now be mannequins.

", + "date": "2020-01-01", + "criticality": "breaking", + "owner": "tambling" + } + ], + "2019-04-01": [ + { + "location": "LegacyMigration.uploadUrlTemplate", + "description": "

uploadUrlTemplate will be removed. Use uploadUrl instead.

", + "reason": "

uploadUrlTemplate is being removed because it is not a standard URL and adds an extra user step.

", + "date": "2019-04-01", + "criticality": "breaking", + "owner": "tambling" + } + ] +} diff --git a/plugins/catalog/testdata/github-graphql-upcoming-changes-fc7cedfe.json b/plugins/catalog/testdata/github-graphql-upcoming-changes-fc7cedfe.json new file mode 100644 index 0000000..05cff49 --- /dev/null +++ b/plugins/catalog/testdata/github-graphql-upcoming-changes-fc7cedfe.json @@ -0,0 +1,252 @@ +{ + "2026-07-01": [ + { + "location": "Team.viewerSubscription", + "description": "

viewerSubscription will be removed.

", + "reason": "

Team.viewerSubscription will be removed. Team notifications subscriptions are being deprecated.

", + "date": "2026-07-01", + "criticality": "breaking", + "owner": "peter-evans" + } + ], + "2026-04-01": [ + { + "location": "TeamRemoveRepositoryAuditEntry.userUrl", + "description": "

userUrl will be removed.

", + "reason": "

The GraphQL audit-log is deprecated. Please use the REST API instead.

", + "date": "2026-04-01", + "criticality": "breaking", + "owner": "audit_logs" + } + ], + "2026-01-01": [ + { + "location": "NotificationThread.subject", + "description": "

subject will be removed. Use the optionalSubject field instead.

", + "reason": "

Null values are possible for this field.

", + "date": "2026-01-01", + "criticality": "breaking", + "owner": "github/notifications" + } + ], + "2025-10-01": [ + { + "location": "SecurityAdvisory.cvss", + "description": "

cvss will be removed. New cvss_severities field will now contain both cvss_v3 and cvss_v4 properties.

", + "reason": "

cvss will be removed.

", + "date": "2025-10-01", + "criticality": "breaking", + "owner": "github/advisory-database" + } + ], + "2025-04-01": [ + { + "location": "User.viewerCanCreateProjects", + "description": "

viewerCanCreateProjects will be removed.

", + "reason": "

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/.

", + "date": "2025-04-01", + "criticality": "breaking", + "owner": "github/memex" + } + ], + "2025-01-01": [ + { + "location": "AddMobileDevicePublicKeyPayload.expiresAt", + "description": "

expiresAt will be removed. Do not rely on this field, it is currently set to a date far in the future if a device key is expirationless

", + "reason": "

We are deprecating expirations for mobile device keys used in mobile 2FA

", + "date": "2025-01-01", + "criticality": "breaking", + "owner": "chriskirkland" + } + ], + "2024-10-01": [ + { + "location": "Workflow.hasWorkflowDispatchTrigger", + "description": "

hasWorkflowDispatchTrigger will be removed. Use has_workflow_dispatch_trigger_for_branch(branch_ref) instead.

", + "reason": "

has_workflow_dispatch_trigger is being removed because it can be misleading and only checks a repository's default branch

", + "date": "2024-10-01", + "criticality": "breaking", + "owner": "stevepopovich" + } + ], + "2024-07-01": [ + { + "location": "PullRequestReviewComment.databaseId", + "description": "

databaseId will be removed. Use fullDatabaseId instead.

", + "reason": "

databaseId will be removed because it does not support 64-bit signed integer identifiers.

", + "date": "2024-07-01", + "criticality": "breaking", + "owner": "JanKoszewski" + } + ], + "2024-04-01": [ + { + "location": "TopicSuggestionDeclineReason.TOO_SPECIFIC", + "description": "

TOO_SPECIFIC will be removed.

", + "reason": "

Suggested topics are no longer supported

", + "date": "2024-04-01", + "criticality": "breaking", + "owner": "calvinchilds" + } + ], + "2023-10-01": [ + { + "location": "PullRequestReviewComment.position", + "description": "

position will be removed. Use the line and startLine fields instead, which are file line numbers instead of diff line numbers

", + "reason": "

We are phasing out diff-relative positioning for PR comments

", + "date": "2023-10-01", + "criticality": "breaking", + "owner": "aharpole" + } + ], + "2023-07-01": [ + { + "location": "ProjectV2ItemFieldGroup.field", + "description": "

field will be removed. Check out the ProjectV2ItemFieldGroup#groupByField API as an example for the more capable alternative.

", + "reason": "

The ProjectV2ItemFieldGroup#field API is deprecated in favour of the more capable ProjectV2ItemFieldGroup#groupByField API.

", + "date": "2023-07-01", + "criticality": "breaking", + "owner": "stevepopovich" + } + ], + "2023-04-01": [ + { + "location": "Repository.squashPrTitleUsedAsDefault", + "description": "

squashPrTitleUsedAsDefault will be removed. Use Repository.squashMergeCommitTitle instead.

", + "reason": "

squashPrTitleUsedAsDefault will be removed.

", + "date": "2023-04-01", + "criticality": "breaking", + "owner": "github/pull_requests" + } + ], + "2023-02-10": [ + { + "location": "PackageType.MAVEN", + "description": "

MAVEN will be removed.

", + "reason": "

MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2023-02-10", + "criticality": "breaking", + "owner": "ankitkaushal01" + } + ], + "2023-01-01": [ + { + "location": "ProjectV2View.visibleFields", + "description": "

visibleFields will be removed. Check out the ProjectV2View#fields API as an example for the more capable alternative.

", + "reason": "

The ProjectV2View#visibleFields API is deprecated in favour of the more capable ProjectV2View#fields API.

", + "date": "2023-01-01", + "criticality": "breaking", + "owner": "mattruggio" + } + ], + "2022-12-28": [ + { + "location": "PackageType.RUBYGEMS", + "description": "

RUBYGEMS will be removed.

", + "reason": "

RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2022-12-28", + "criticality": "breaking", + "owner": "ankitkaushal01" + } + ], + "2022-11-21": [ + { + "location": "PackageType.NUGET", + "description": "

NUGET will be removed.

", + "reason": "

NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2022-11-21", + "criticality": "breaking", + "owner": "s-anupam" + } + ], + "2022-10-01": [ + { + "location": "RemovePullRequestFromMergeQueueInput.branch", + "description": "

branch will be removed.

", + "reason": "

PRs are removed from the merge queue for the base branch, the branch argument is now a no-op

", + "date": "2022-10-01", + "criticality": "breaking", + "owner": "jhunschejones" + } + ], + "2022-07-01": [ + { + "location": "Query.sponsorables.dependencyEcosystem", + "description": "

dependencyEcosystem will be removed. Use the ecosystem argument instead.

", + "reason": "

The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.

", + "date": "2022-07-01", + "criticality": "breaking", + "owner": "cheshire137" + } + ], + "2021-10-01": [ + { + "location": "ReactionGroup.users", + "description": "

users will be removed. Use the reactors field instead.

", + "reason": "

Reactors can now be mannequins, bots, and organizations.

", + "date": "2021-10-01", + "criticality": "breaking", + "owner": "synthead" + } + ], + "2021-06-21": [ + { + "location": "PackageType.DOCKER", + "description": "

DOCKER will be removed.

", + "reason": "

DOCKER will be removed from this enum as this type will be migrated to only be used by the Packages REST API.

", + "date": "2021-06-21", + "criticality": "breaking", + "owner": "reybard" + } + ], + "2021-01-01": [ + { + "location": "MergeStateStatus.DRAFT", + "description": "

DRAFT will be removed. Use PullRequest.isDraft instead.

", + "reason": "

DRAFT state will be removed from this enum and isDraft should be used instead

", + "date": "2021-01-01", + "criticality": "breaking", + "owner": "nplasterer" + } + ], + "2020-10-01": [ + { + "location": "Sponsorship.sponsor", + "description": "

sponsor will be removed. Use Sponsorship.sponsorEntity instead.

", + "reason": "

Sponsorship.sponsor will be removed.

", + "date": "2020-10-01", + "criticality": "breaking", + "owner": "nholden" + } + ], + "2020-04-01": [ + { + "location": "Sponsorship.maintainer", + "description": "

maintainer will be removed. Use Sponsorship.sponsorable instead.

", + "reason": "

Sponsorship.maintainer will be removed.

", + "date": "2020-04-01", + "criticality": "breaking", + "owner": "antn" + } + ], + "2020-01-01": [ + { + "location": "UnassignedEvent.user", + "description": "

user will be removed. Use the assignee field instead.

", + "reason": "

Assignees can now be mannequins.

", + "date": "2020-01-01", + "criticality": "breaking", + "owner": "tambling" + } + ], + "2019-04-01": [ + { + "location": "LegacyMigration.uploadUrlTemplate", + "description": "

uploadUrlTemplate will be removed. Use uploadUrl instead.

", + "reason": "

uploadUrlTemplate is being removed because it is not a standard URL and adds an extra user step.

", + "date": "2019-04-01", + "criticality": "breaking", + "owner": "tambling" + } + ] +} diff --git a/plugins/catalog/testdata/golden/github-graphql.json b/plugins/catalog/testdata/golden/github-graphql.json new file mode 100644 index 0000000..579aac2 --- /dev/null +++ b/plugins/catalog/testdata/golden/github-graphql.json @@ -0,0 +1,90 @@ +[ + { + "id": 0, + "fingerprint": "sha256:b2d3b47705a97f5ad0eba1ad05610205e8134a851eb1a61e7ff4588dcb316f64", + "api": "github/graphql", + "version": "2027-01-01", + "previous_version": "2026-02-13", + "change_type": "deprecation", + "breaking": false, + "subject": { + "type": "api_operation", + "kind": "schema_property", + "side": "response", + "schema": "CheckAnnotation", + "property": "databaseId" + }, + "description": "GitHub's GraphQL API removes CheckAnnotation.databaseId on 2027-01-01: code that queries or sends it fails from that date.", + "migration_hint": "databaseId will be removed. Use fullDatabaseId instead. databaseId will be removed because it does not support 64-bit signed integer identifiers.", + "source_url": "https://raw.githubusercontent.com/github/docs/3a14e541873e834edf32b43b71911fe80d109a70/src/graphql/data/fpt/upcoming-changes.json", + "source_excerpt": "{\"location\":\"CheckAnnotation.databaseId\",\"description\":\"

databaseId will be removed. Use fullDatabaseId instead.

\",\"reason\":\"

databaseId will be removed because it does not support 64-bit signed integer identifiers.

\",\"date\":\"2027-01-01\",\"criticality\":\"breaking\"}", + "confidence": 1, + "detected_at": "2026-11-14T12:00:00Z" + }, + { + "id": 0, + "fingerprint": "sha256:cd07336291aa000b124d74fd081c22b95cc1ca0fabadf51cf776e9bb93e309f5", + "api": "github/graphql", + "version": "2027-01-01", + "previous_version": "2026-02-13", + "change_type": "deprecation", + "breaking": false, + "subject": { + "type": "api_operation", + "kind": "schema_property", + "side": "response", + "schema": "Artifact", + "property": "databaseId" + }, + "description": "GitHub's GraphQL API removes Artifact.databaseId on 2027-01-01: code that queries or sends it fails from that date.", + "migration_hint": "databaseId will be removed. Use fullDatabaseId instead. databaseId will be removed because it does not support 64-bit signed integer identifiers.", + "source_url": "https://raw.githubusercontent.com/github/docs/3a14e541873e834edf32b43b71911fe80d109a70/src/graphql/data/fpt/upcoming-changes.json", + "source_excerpt": "{\"location\":\"Artifact.databaseId\",\"description\":\"

databaseId will be removed. Use fullDatabaseId instead.

\",\"reason\":\"

databaseId will be removed because it does not support 64-bit signed integer identifiers.

\",\"date\":\"2027-01-01\",\"criticality\":\"breaking\"}", + "confidence": 1, + "detected_at": "2026-11-14T12:00:00Z" + }, + { + "id": 0, + "fingerprint": "sha256:da197a3086fc3c9c3642b6045598ee0f65d32f78b16c26c3697eedc79c0463ed", + "api": "github/graphql", + "version": "2026-10-01", + "previous_version": "2026-03-03", + "change_type": "deprecation", + "breaking": false, + "subject": { + "type": "api_operation", + "kind": "schema_property", + "side": "response", + "schema": "User", + "property": "viewerRelevantRepositories" + }, + "description": "GitHub's GraphQL API removes User.viewerRelevantRepositories on 2026-10-01: code that queries or sends it fails from that date.", + "migration_hint": "viewerRelevantRepositories will be removed. Use viewerCopilotChatRepositorySuggestions instead. viewerRelevantRepositories has been renamed to viewerCopilotChatRepositorySuggestions.", + "source_url": "https://raw.githubusercontent.com/github/docs/a934f06d211bef668253e3826c118a4e559dc1ba/src/graphql/data/fpt/upcoming-changes.json", + "source_excerpt": "{\"location\":\"User.viewerRelevantRepositories\",\"description\":\"

viewerRelevantRepositories will be removed. Use viewerCopilotChatRepositorySuggestions instead.

\",\"reason\":\"

viewerRelevantRepositories has been renamed to viewerCopilotChatRepositorySuggestions.

\",\"date\":\"2026-10-01\",\"criticality\":\"breaking\"}", + "confidence": 1, + "detected_at": "2026-11-14T12:00:00Z" + }, + { + "id": 0, + "fingerprint": "sha256:baa075ad2dbf3bd79789a7485b386db64b050383e1b6bf2de5ac11719d70263f", + "api": "github/graphql", + "version": "2026-10-01", + "previous_version": "2026-05-22", + "change_type": "deprecation", + "breaking": false, + "subject": { + "type": "api_operation", + "kind": "schema_property", + "side": "response", + "schema": "CopilotAgentTask", + "property": "type" + }, + "description": "GitHub's GraphQL API removes CopilotAgentTask.type on 2026-10-01: code that queries or sends it fails from that date.", + "migration_hint": "type will be removed. Use codingAgentFilter and codingAgentTypeFilter instead. type will be removed.", + "source_url": "https://raw.githubusercontent.com/github/docs/c5738e5815fff90d38f0166f7c9949bfb664e003/src/graphql/data/fpt/upcoming-changes.json", + "source_excerpt": "{\"location\":\"CopilotAgentTask.type\",\"description\":\"

type will be removed. Use codingAgentFilter and codingAgentTypeFilter instead.

\",\"reason\":\"

type will be removed.

\",\"date\":\"2026-10-01\",\"criticality\":\"breaking\"}", + "confidence": 1, + "detected_at": "2026-11-14T12:00:00Z" + } +] diff --git a/providers/github-graphql.md b/providers/github-graphql.md new file mode 100644 index 0000000..134ae57 --- /dev/null +++ b/providers/github-graphql.md @@ -0,0 +1,39 @@ +# GitHub GraphQL API (`github/graphql`) + +## What it watches + +Removals GitHub announces for its GraphQL API: a field, an argument, an input field or an enum value, with the date it goes. One `deprecation` event per newly announced removal, its `version` the removal date. + +Kind: `catalog` (`plugins/catalog`), the `UpcomingChanges` reader (`plugins/catalog/graphql.go`). + +## Why this source + +- **Source:** [`src/graphql/data/fpt/upcoming-changes.json`](https://github.com/github/docs/blob/main/src/graphql/data/fpt/upcoming-changes.json) in github/docs, read at every commit that changed it (listed from GitHub's commits API, `?path=`). It's the file [Breaking changes](https://docs.github.com/en/graphql/overview/breaking-changes) on docs.github.com is built from. Checked on 2026-11-21: 1,291 entries, every one `"criticality": "breaking"`, 29 commits since 2023-05-01. +- **Why this one:** one JSON object keyed by removal date, each entry naming its location (`RepositoryPermission.TRIAGE_PLUS`), what to do and why, from GitHub's own schema tooling. A commit never changes, so the raw file at it is its own citation. +- **Alternatives considered:** + - **The Breaking changes page** (HTML): the same entries, rendered; the JSON is what it's made from. + - **The GraphQL schema** (`schema.docs.graphql`, `@deprecated(reason: "… Removal on 2027-04-01 UTC.")`): the same dates inside a GraphQL SDL, which needs a schema reader no kind has. + - **The GitHub changelog**: announces some of these, in prose, with no location. +- **Quote:** `{"location": "RepositoryPermission.TRIAGE_PLUS", "description": "

TRIAGE_PLUS will be removed. Use MODERATE instead.

", "date": "2027-04-01", "criticality": "breaking"}`. + +## How the provider announces changes + +- GitHub's GraphQL API has no versions: a change is announced here with its removal date, a quarter's first day (`2026-10-01`, `2027-01-01`). +- Announcements come a few at a time (one or two a month in 2026), sometimes in a batch (1,109 entries on 2025-04-14, the audit-log fields). + +## What the plugin reads and ignores + +- Reads every entry of the file at each commit. An entry (location and date) in the newer commit's file that the older one didn't have is a `deprecation` event: `version` the removal date (the API has no versions; the day it breaks is what a gate compares, as a model's shutdown date is), `previous_version` the older commit's date, the hint the entry's description and reason as text. The excerpt is the entry's fields as the file writes them, its `owner` left out. +- Subject (`api_operation`): an input object's field (`AddPullRequestReviewInput.comments`) or a root field's argument (`Query.sponsorables.dependencyEcosystem`) is a `request_parameter` of `POST /graphql`, its `property` the location; any other location (a root field itself, a type's field or its argument, an enum value) is a `schema_property`, its `schema` the type and its `property` the rest (`RepositoryPermission` / `TRIAGE_PLUS`). +- An entry a commit drops while still upcoming and a later commit restores is the same event (same removal date, same fingerprint), so it isn't announced twice. +- Ignores an entry dated before the commit that adds it: a revert putting back a removal already made, not an announcement. On 2026-01-05 the file lost 17 such entries, got them back the next day and lost them again on 2026-01-08: no event (the pinned drop test). +- Ignores an entry leaving the file: the removal shipped, or GitHub withdrew it, and the file doesn't say which. +- A first read, with no commit before it, has nothing to compare: no events. + +## Known gaps + +- `previous_version` (a commit date) to `version` (the removal date) isn't a range of this source's listed versions: the removal date is when the change breaks, as a model's shutdown date is. Whether the feed's coverage logic should treat such a pair differently is for the contract (patch-it) to say. + +- The removal itself (the day it ships) isn't a separate `breaking` event; the deprecation names the date. +- GitHub Enterprise Server's own files (`ghes-*`) aren't read. +- A location GitHub moves to a new date is a new event (a new `version`), alongside the first.