Migrate changelog management to hark

.github/pull_request_template.md

@@ -10,14 +10,6 @@ List out the key changes made in this PR, e.g.
 ### See Also
 <!-- Include any links or additional information that help explain this change. -->
 
-## Changelog
-<!-- Heads up! This section should include entries for any user-facing changes.
-Either fill it out or remove it if there are no entries to report.
+## Configuration
 
-List changes that affect end users, e.g.
-- Fixes crash when calling `foo.bar()` with null argument
-- Adds support for new `baz` parameter on `PaymentIntent` creation
-
-List breaking changes first with a ⚠️ prefix, e.g.
-- ⚠️ Removes deprecated `legacy_method` function
--->
+- [ ] `skip-changefile`: This PR is not a user-facing change, so there's no changefile.

.github/workflows/changelog.yml

@@ -0,0 +1,23 @@
+name: Changelog
+
+on:
+  pull_request:
+    # opened, synchronize and reopened are the defaults; `edited` is what makes this
+    # re-run when someone toggles an opt-out box in the description
+    types: [opened, synchronize, reopened, edited]
+
+permissions: {}
+
+jobs:
+  changefile:
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: read # check out the repo so `hark validate` can read .hark/
+      pull-requests: read # list the files this pull request adds
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: stripe/hark/actions/require-changefile@v1
+      - uses: stripe/hark/actions/require-migration-guide@v1
+      - uses: stripe/hark/actions/check-pr-links@v1

.github/zizmor.yml

@@ -6,3 +6,4 @@ rules:
     config:
       policies:
         "stripe/openapi/*": ref-pin
+        "stripe/hark/*": ref-pin

.hark/changes/2012-05-16_unknown_add-missing-fields.change.md

@@ -0,0 +1,4 @@
+---
+title: "Add missing fields to Charge, Coupon, Discount, Event, and Invoice models (github issue #12)"
+released_in_version: 1.1.0
+---

.hark/changes/2012-05-16_unknown_add-new-deletediscou.change.md

@@ -0,0 +1,4 @@
+---
+title: Add new deleteDiscount method to com.stripe.model.Customer
+released_in_version: 1.1.0
+---

.hark/changes/2012-05-16_unknown_change-type-cvccheck.change.md

@@ -0,0 +1,4 @@
+---
+title: "Change type of cvcCheck, addressZipCheck, and addressLine1Check attributes on com.stripe.model.Card; values of those fields will be \"pass\", \"fail\", \"unchecked\", or null (github issue #11)"
+released_in_version: 1.1.0
+---

.hark/changes/2012-05-16_unknown_include-parameters-passed.change.md

@@ -0,0 +1,4 @@
+---
+title: "Include parameters passed to any object's delete method in actual API requests (github issue #10)"
+released_in_version: 1.1.0
+---

.hark/changes/2012-05-16_unknown_numerous-test-suite.change.md

@@ -0,0 +1,4 @@
+---
+title: Numerous test suite improvements
+released_in_version: 1.1.0
+---

.hark/changes/2012-05-16_unknown_remove-code-percentoff.change.md

@@ -0,0 +1,4 @@
+---
+title: Remove code and percentOff attributes from com.stripe.model.Discount. Stripe never returned these values for Discount objects, so they would previously always be null
+released_in_version: 1.1.0
+---

.hark/changes/2012-05-16_unknown_switch-using-http.change.md

@@ -0,0 +1,4 @@
+---
+title: "Switch from using HTTP Basic auth to Bearer auth. (Note: Stripe will support Basic auth for the indefinite future, but recommends Bearer auth when possible going forward)"
+released_in_version: 1.1.0
+---

.hark/changes/2012-05-24_unknown_use-string-length.change.md

@@ -0,0 +1,4 @@
+---
+title: Use String.length() == 0 instead of String.isEmpty() for compatibility with JDK 1.5 (needed for Android 2.2)
+released_in_version: 1.1.1
+---

.hark/changes/2012-08-06_unknown_allow-specificatio-api.change.md

@@ -0,0 +1,4 @@
+---
+title: Allow specification of API key at the API call level
+released_in_version: 1.1.2
+---

.hark/changes/2012-08-17_unknown_add-account-api.change.md

@@ -0,0 +1,4 @@
+---
+title: Add the Account API resource
+released_in_version: 1.1.3
+---

.hark/changes/2012-08-31_unknown_add-update-pay.change.md

@@ -0,0 +1,4 @@
+---
+title: Add update and pay methods for Invoice resource
+released_in_version: 1.1.4
+---

.hark/changes/2012-09-26_unknown_pass-query-parameters.change.md

@@ -0,0 +1,4 @@
+---
+title: "Pass query parameters to DELETE-based methods when using Google App Engine (github issue #17)"
+released_in_version: 1.1.5
+---

.hark/changes/2012-10-15_unknown_add-fee-api.change.md

@@ -0,0 +1,4 @@
+---
+title: Add Fee API resource, add feeDetails to Charge API resource.
+released_in_version: 1.1.6
+---

.hark/changes/2012-10-24_unknown_add-quantity-subscription.change.md

@@ -0,0 +1,4 @@
+---
+title: Add quantity to Subscription
+released_in_version: 1.1.7
+---

.hark/changes/2012-10-30_unknown_add-support-creating.change.md

@@ -0,0 +1,4 @@
+---
+title: Add support for creating invoices
+released_in_version: 1.1.8
+---

.hark/changes/2012-10-30_unknown_add-support-new.change.md

@@ -0,0 +1,4 @@
+---
+title: Add support for new Invoice.lines return format
+released_in_version: 1.1.8
+---

.hark/changes/2012-11-08_unknown_add-new-dispute.change.md

@@ -0,0 +1,4 @@
+---
+title: Add new Dispute resource
+released_in_version: 1.1.9
+---

.hark/changes/2012-11-08_unknown_add-support-updating.change.md

@@ -0,0 +1,4 @@
+---
+title: Add support for updating charge disputes
+released_in_version: 1.1.9
+---

.hark/changes/2012-11-15_unknown_add-amountoff-currency.change.md

@@ -0,0 +1,4 @@
+---
+title: Add amountOff and currency to Coupon resource
+released_in_version: 1.1.10
+---

.hark/changes/2012-11-15_unknown_add-currency-invoice.change.md

@@ -0,0 +1,4 @@
+---
+title: Add currency to Invoice resource
+released_in_version: 1.1.10
+---

.hark/changes/2012-11-17_unknown_explict-cast-javax.change.md

@@ -0,0 +1,4 @@
+---
+title: Explict cast to javax.net.ssl.HttpsURLConnection to prevent issues with user imports
+released_in_version: 1.1.11
+---

.hark/changes/2012-12-24_unknown_add-option-provide.change.md

@@ -0,0 +1,4 @@
+---
+title: Add option to provide custom URL handler
+released_in_version: 1.1.12
+---

.hark/changes/2012-12-29_unknown_add-addresscity-card.change.md

@@ -0,0 +1,4 @@
+---
+title: Add address_city to card
+released_in_version: 1.1.13
+---

.hark/changes/2012-12-29_unknown_upgrade-google-gson.change.md

@@ -0,0 +1,4 @@
+---
+title: Upgrade Google GSON to 2.2.2
+released_in_version: 1.1.13
+---

.hark/changes/2013-01-15_unknown_add-support-setting.change.md

@@ -0,0 +1,4 @@
+---
+title: Add support for setting Stripe API version override.
+released_in_version: 1.1.14
+---

.hark/changes/2013-02-01_unknown_add-support-plan.change.md

@@ -0,0 +1,4 @@
+---
+title: Add support for plan interval count.
+released_in_version: 1.1.15
+---

.hark/changes/2013-02-01_unknown_list-all-checked.change.md

@@ -0,0 +1,4 @@
+---
+title: List all checked exceptions throws by methods.
+released_in_version: 1.1.15
+---

.hark/changes/2013-02-15_unknown_fix-off-one.change.md

@@ -0,0 +1,4 @@
+---
+title: "Fix off-by-one error in deserializing events (github issue #27)."
+released_in_version: 1.1.16
+---

.hark/changes/2013-02-18_unknown_add-ability-deserialize.change.md

@@ -0,0 +1,4 @@
+---
+title: Add ability to deserialize account-related events.
+released_in_version: 1.1.17
+---

.hark/changes/2013-02-18_unknown_add-user-id.change.md

@@ -0,0 +1,4 @@
+---
+title: Add user ID to Event object.
+released_in_version: 1.1.17
+---

.hark/changes/2013-03-18_unknown_add-support-charge.change.md

@@ -0,0 +1,4 @@
+---
+title: Add support for charge capture.
+released_in_version: 1.1.18
+---

.hark/changes/2013-04-20_unknown_add-new-recipient.change.md

@@ -0,0 +1,4 @@
+---
+title: Add new Recipient resource
+released_in_version: 1.2.0
+---

.hark/changes/2013-04-20_unknown_allow-transfers-creatable.change.md

@@ -0,0 +1,4 @@
+---
+title: Allow Transfers to be creatable
+released_in_version: 1.2.0
+---

.hark/changes/2013-04-20_unknown_fix-transfertran-fee.change.md

@@ -0,0 +1,4 @@
+---
+title: Fix TransferTransaction fee retrieval
+released_in_version: 1.2.1
+---

.hark/changes/2013-04-25_unknown_add-more-objects.change.md

@@ -0,0 +1,4 @@
+---
+title: Add more objects to Deserializer
+released_in_version: 1.2.2
+---

.hark/changes/2013-05-07_unknown_rename-bankaccount-property.change.md

@@ -0,0 +1,4 @@
+---
+title: Rename BankAccount property `valid` to `validated`
+released_in_version: 1.2.3
+---

.hark/changes/2013-06-22_unknown_add-more-balance.change.md

@@ -0,0 +1,4 @@
+---
+title: Add more Balance API resource, and add to deserializer.
+released_in_version: 1.2.4
+---

.hark/changes/2013-07-15_unknown_add-money-class.change.md

@@ -0,0 +1,4 @@
+---
+title: Add a Money class for representing account balances in individual currencies
+released_in_version: 1.2.5
+---

.hark/changes/2013-07-15_unknown_add-striperawjso-type.change.md

@@ -0,0 +1,4 @@
+---
+title: Add a StripeRawJsonObject type for deserializing webhook events we don't recognize
+released_in_version: 1.2.5
+---

.hark/changes/2013-07-15_unknown_add-support-new.change.md

@@ -0,0 +1,6 @@
+---
+title: Add support for new cards API.
+released_in_version: 1.2.5
+---
+
+* You will probably need to upgrade the Stripe API version on your account to 2013-07-05 or explicitly specify an API version with com.stripe.Stripe.apiVersion when you switch to this release of the bindings. More information about the relevant changes can be found at https://docs.stripe.com/changelog/2013-07-05 and http://bit.ly/13miHM8

.hark/changes/2013-07-30_unknown_add-createcard-customer.change.md

@@ -0,0 +1,4 @@
+---
+title: Add 'createCard' to Customer
+released_in_version: 1.2.6
+---

.hark/changes/2013-07-30_unknown_parse-card-objects.change.md

@@ -0,0 +1,4 @@
+---
+title: Parse card objects when receiving customer.card.created events
+released_in_version: 1.2.6
+---

.hark/changes/2013-07-30_unknown_update-card-collections.change.md

@@ -0,0 +1,4 @@
+---
+title: Update card collections bindings
+released_in_version: 1.2.6
+---

.hark/changes/2013-07-31_unknown_enable-createcard-use.change.md

@@ -0,0 +1,4 @@
+---
+title: Enable createCard() to use a token
+released_in_version: 1.2.7
+---

.hark/changes/2013-08-12_unknown_add-support-unsetting.change.md

@@ -0,0 +1,4 @@
+---
+title: Add support for unsetting attributes by updating with a null value. Setting properties to a blank string is now an error.
+released_in_version: 1.2.8
+---

.hark/changes/2013-08-19_unknown_add-balancetrans-api.change.md

@@ -0,0 +1,4 @@
+---
+title: Add BalanceTransaction API resource
+released_in_version: 1.3.0
+---

.hark/changes/2013-08-19_unknown_add-refund-resource.change.md

@@ -0,0 +1,4 @@
+---
+title: Add Refund resource
+released_in_version: 1.3.0
+---

.hark/changes/2013-08-19_unknown_resource-updates.change.md

@@ -0,0 +1,8 @@
+---
+title: Resource updates
+released_in_version: 1.3.0
+---
+
+* Remove `fee`, `feeDetails` from Transfer and Charge resources
+* Add `balanceTransaction` to Transfer, Charge, and Dispute resources
+* Add `refunds` to Charge resource

.hark/changes/2013-08-21_unknown_patch-release-missing.change.md

@@ -0,0 +1,4 @@
+---
+title: Patch release with missing field, added tests
+released_in_version: 1.3.1
+---

.hark/changes/2013-08-30_unknown_add-id-field.change.md

@@ -0,0 +1,4 @@
+---
+title: Add `id` field to `Subscription`
+released_in_version: 1.3.2
+---

.hark/changes/2013-08-30_unknown_add-missing-fields.change.md

@@ -0,0 +1,9 @@
+---
+title: Add missing fields to `BalanceTransaction`
+released_in_version: 1.3.2
+---
+
+* `id`
+* `fee`
+* `fee_details`
+* `description`

.hark/changes/2013-08-30_unknown_add-missing-retrieve.change.md

@@ -0,0 +1,4 @@
+---
+title: Add missing `retrieve` method to `BalanceTransaction`
+released_in_version: 1.3.2
+---

.hark/changes/2013-09-03_unknown_tweak-card-create.change.md

@@ -0,0 +1,4 @@
+---
+title: Tweak card create to align it with docs
+released_in_version: 1.4.0
+---

.hark/changes/2013-09-04_unknown_fix-return-type.change.md

@@ -0,0 +1,4 @@
+---
+title: Fix return type of CustomerCardCollection.retrieve
+released_in_version: 1.4.1
+---

.hark/changes/2013-09-18_unknown_add-support-closing.change.md

@@ -0,0 +1,4 @@
+---
+title: Add support for closing disputes
+released_in_version: 1.4.2
+---

.hark/changes/2013-10-17_unknown_add-support-metadata.change.md

@@ -0,0 +1,4 @@
+---
+title: Add support for metadata API
+released_in_version: 1.5.0
+---

.hark/changes/2013-10-17_unknown_added-field-transferenab.change.md

@@ -0,0 +1,4 @@
+---
+title: Added field transfer_enabled to Account API object (thanks, kurguzov)
+released_in_version: 1.5.1
+---

.hark/changes/2013-12-04_unknown_add-applicationf-api.change.md

@@ -0,0 +1,4 @@
+---
+title: Add ApplicationFee API resource
+released_in_version: 1.6.1
+---

.hark/changes/2014-01-08_unknown_fix-return-type.change.md

@@ -0,0 +1,4 @@
+---
+title: Fix return type of Coupon.getRedeemBy
+released_in_version: 1.6.2
+---

.hark/changes/2014-01-13_unknown_add-default-currency.change.md

@@ -0,0 +1,4 @@
+---
+title: "Add default currency to Account object (fixes #46)"
+released_in_version: 1.6.3
+---

.hark/changes/2014-01-13_unknown_add-metadata-plan.change.md

@@ -0,0 +1,4 @@
+---
+title: Add metadata to plan object (thanks, desirable-objects)
+released_in_version: 1.6.3
+---

.hark/changes/2014-01-13_unknown_remove-plan-customer.change.md

@@ -0,0 +1,4 @@
+---
+title: "Remove plan from Customer (fixes #42)"
+released_in_version: 1.6.3
+---

.hark/changes/2014-01-13_unknown_style-improvements-see.change.md

@@ -0,0 +1,4 @@
+---
+title: "Style improvements (see #30) (thanks, steve-nester-uk)"
+released_in_version: 1.6.3
+---

.hark/changes/2014-01-13_unknown_support-overriding-base.change.md

@@ -0,0 +1,4 @@
+---
+title: Support overriding base url (for testing) (user request)
+released_in_version: 1.6.3
+---

.hark/changes/2014-01-16_unknown_added-metadata-invoiceitem.change.md

@@ -0,0 +1,4 @@
+---
+title: "Added metadata to InvoiceItem and InvoiceLineItem (fixes #59)"
+released_in_version: 1.6.4
+---

.hark/changes/2014-01-22_unknown_dry-d-some.change.md

@@ -0,0 +1,4 @@
+---
+title: DRY'd some of the application fee urls
+released_in_version: 1.6.5
+---

.hark/changes/2014-01-22_unknown_fixed-url-refund.change.md

@@ -0,0 +1,4 @@
+---
+title: "Fixed url to refund application fees (fixes #60)"
+released_in_version: 1.6.5
+---

.hark/changes/2014-01-29_unknown_add-support-multiple.change.md

@@ -0,0 +1,4 @@
+---
+title: Add support for multiple subscriptions per customer
+released_in_version: 1.7.0
+---