docs: add CHANGELOG.md and package manifest URLs

[bobbyg603]

Closes #156

Adds a keepachangelog-format CHANGELOG.md at the package root and fills in the three manifest URL fields the Package Manager UI reads.

Manifest fields

documentationUrl, changelogUrl, and licensesUrl are documented optional properties of the Unity package manifest — confirmed against Package manifest, which describes each as a "custom location for this package's ... specified as a URL". The Package Manager falls back to the in-package CHANGELOG.md, Documentation~, and LICENSE.md when the URL is unreachable, so shipping the file and the URL is the intended combination, not a duplication.

• documentationUrl → https://docs.bugsplat.com/integrations/game-development/unity (verified live; the older introduction/getting-started/integrations/... path 404s)
• changelogUrl → the new CHANGELOG.md on main
• licensesUrl → the existing LICENSE.md on main

package.json parses cleanly under both python -m json.tool and node -e "require('./package.json')". A CHANGELOG.md.meta is included so the package ships a stable GUID for the asset, matching the existing README.md.meta/LICENSE.md.meta.

Why "Unreleased" rather than a date

The 5.0.0 section is headed ## [5.0.0] - Unreleased. Keep a Changelog's guidance is an Unreleased section at the top, but the version here is not unknown — package.json already says 5.0.0 and the tag simply hasn't been cut. Naming the version keeps the link reference and the compare URL usable now, while - Unreleased in the date slot stops it reading as shipped. At release, that one word becomes the date; nothing else moves. Per the task, no version bump is included.

Sourcing

The 5.0.0 entry is derived from #123 and then verified against the code, not transcribed. Two items in the issue's summary did not survive that check:

• PostAllCrashes/PostCrash/PostMostRecentCrash were removed, not marked [Obsolete]. There is no [Obsolete] attribute anywhere in the tree, the methods are gone from Runtime/BugSplat.cs (they exist at v4.1.0:Runtime/BugSplat.cs:395,410,425), and README.md:393 already says "have been removed". Listed under Removed.
• The Unity 6000.0 minimum is not a 5.0.0 change. v3.2.2 declared 2021.3 and v4.0.0 declared 6000.0, and the v4.0.0 release notes call it out as that release's breaking change. Recorded under 4.0.0 instead.

Everything else was confirmed: WindowsReporter.cs/INativeCrashReporter.cs deleted, Attributes changed from Dictionary<string, string> to List<BugSplatAttribute> with the new [Serializable] type, SymbolUploadClientId/SymbolUploadClientSecret deleted from the options asset, SYMBOL_UPLOAD_CLIENT_ID/SYMBOL_UPLOAD_CLIENT_SECRET as the env var names in BugSplatSymbolUploadCredentials.cs, the ~/.bugsplat/credentials/<database>.sh path shape, the three sample scripts and the Button_ForceCrash prefab deleted, Post(FileInfo) freed from its #if UNITY_STANDALONE_WIN || UNITY_WSA guard, WindowsWerEnabled, the WER and symbol-upload menu items, and .github/workflows/tests.yml.

One correction from the code: WindowsShowCrashDialog defaults to true (BugSplatOptions.cs), so the changelog says the dialog shows by default and you disable it to upload silently — not the other way round.

Earlier entries cover 4.1.0, 4.0.1, and 4.0.0, sourced from the GitHub release notes and tag dates. Anything before 4.0.0 is deliberately absent — those releases carry no notes worth transcribing and reconstructing them from commit subjects alone would be invention. The file points at the releases page for those instead.

Not included

• No version bump, no tag, no release.
• No README link to the changelog — out of scope for this issue.
• The 5.0.0 entry documents behaviour as merged. The verification checklist in feat!: native Windows crash reporting via bugsplat-windows #123 (ARM64/x86 runtime checks, offline retry, real uploaded reports for several of the merged sub-PRs) is still open and is tracked there, not here.

[Copilot]

Pull request overview

Adds end-user facing package metadata so Unity Package Manager can surface docs/license/changelog links, and introduces an in-repo Keep a Changelog-style CHANGELOG.md to document notable releases (including 5.0.0’s breaking changes).

Changes:

• Added documentationUrl, changelogUrl, and licensesUrl to the Unity package manifest (package.json).
• Added a Keep a Changelog-format CHANGELOG.md at the package root.
• Added CHANGELOG.md.meta so the asset ships with a stable Unity GUID.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

File	Description
package.json	Adds Unity Package Manager “custom location” URL fields for docs/changelog/license.
CHANGELOG.md	Introduces package-level release notes covering 5.0.0 and recent 4.x releases.
CHANGELOG.md.meta	Ensures Unity tracks the changelog as a stable asset via GUID.

Files not reviewed (1)

• CHANGELOG.md.meta: Generated file

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.