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 nil 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,21 @@
+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/checks@master

.github/zizmor.yml

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

.hark/changes/2010-01-05_unknown_initial-release.change.md

@@ -0,0 +1,4 @@
+---
+title: Initial release
+released_in_version: "1.0.0"
+---

.hark/changes/2010-03-14_unknown_support-recurring-billing.change.md

@@ -0,0 +1,4 @@
+---
+title: Support for recurring billing
+released_in_version: "1.1.0"
+---

.hark/changes/2010-06-06_unknown_support-setcustomers-deletecustom.change.md

@@ -0,0 +1,4 @@
+---
+title: Support for the set_customer_subscription and delete_customer API methods
+released_in_version: "1.2.0"
+---

.hark/changes/2011-01-07_unknown_rename-stripe.change.md

@@ -0,0 +1,4 @@
+---
+title: Rename to Stripe
+released_in_version: 1.3.4
+---

.hark/changes/2011-05-26_unknown_update-new-restful.change.md

@@ -0,0 +1,4 @@
+---
+title: Update for new RESTful API
+released_in_version: 1.5.0
+---

.hark/changes/2012-01-27_unknown_1-6-0.change.md

@@ -0,0 +1,4 @@
+---
+title: 1.6.0 also contains a new inspect/to_string implementation
+released_in_version: 1.6.0
+---

.hark/changes/2012-01-27_unknown_whole-bunch-releases.change.md

@@ -0,0 +1,4 @@
+---
+title: A whole bunch of releases between 1.5.0 and 1.6.0, but few changes, mainly the addition of plans, coupons, events, and tokens
+released_in_version: 1.6.0
+---

.hark/changes/2012-02-22_unknown_fix-stripeobject-inspect.change.md

@@ -0,0 +1,4 @@
+---
+title: "Fix StripeObject#inspect when ActiveSupport 3.0 is loaded"
+released_in_version: 1.6.1
+---

.hark/changes/2012-02-24_unknown_correct-argument-handling.change.md

@@ -0,0 +1,4 @@
+---
+title: "Correct argument handling in StripeObject#as_json"
+released_in_version: 1.6.2
+---

.hark/changes/2012-03-22_unknown_encode-get-query.change.md

@@ -0,0 +1,4 @@
+---
+title: Encode GET query strings ourselves instead of using rest-client to work around a bug
+released_in_version: 1.6.3
+---

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

@@ -0,0 +1,4 @@
+---
+title: Add new delete_discount method to Customer objects
+released_in_version: 1.7.0
+---

.hark/changes/2012-05-17_unknown_add-new-transfer.change.md

@@ -0,0 +1,4 @@
+---
+title: Add new Transfer API resource
+released_in_version: 1.7.0
+---

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

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

.hark/changes/2012-05-17_unknown_switch-http-basic.change.md

@@ -0,0 +1,4 @@
+---
+title: "Switch from 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.7.0
+---

.hark/changes/2012-05-17_unknown_switch-vendored-stripe.change.md

@@ -0,0 +1,4 @@
+---
+title: "Switch from vendored stripe-json to multi_json for all JSON parsing and rendering. This should not impact programmatic usage of the library, but may cause small rendering differences from, e.g., StripeObject#inspect (github issue #22)"
+released_in_version: 1.7.0
+---

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

@@ -0,0 +1,4 @@
+---
+title: Add new Account API resource
+released_in_version: 1.7.1
+---

.hark/changes/2012-08-31_unknown_add-support-new.change.md

@@ -0,0 +1,4 @@
+---
+title: Add support for new pay and update methods for Invoice objects
+released_in_version: 1.7.2
+---

.hark/changes/2012-09-14_unknown_make-sure-both.change.md

@@ -0,0 +1,4 @@
+---
+title: "Make sure that both keys and values of GET params are URL-encoded. NOTE: If you were previously URL-encoding values yourself, you may need to adjust your code."
+released_in_version: 1.7.3
+---

.hark/changes/2012-09-14_unknown_url-encode-post.change.md

@@ -0,0 +1,4 @@
+---
+title: "URL-encode POST params directly, instead of allowing rest-client to do it to work around an unfortunate interaction with the hashery gem (github issue #38)"
+released_in_version: 1.7.3
+---

.hark/changes/2012-10-08_unknown_fix-bug-introduced.change.md

@@ -0,0 +1,6 @@
+---
+title: Fix bug introduced in 1.7.3 calling API methods that take no
+released_in_version: 1.7.4
+---
+
+arguments, like Stripe::Invoice#pay (github issue #42)

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

@@ -0,0 +1,4 @@
+---
+title: Add support for new API lists
+released_in_version: 1.7.5
+---

.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.7.6
+---

.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.7.7
+---

.hark/changes/2012-11-08_unknown_fix-account-api.change.md

@@ -0,0 +1,4 @@
+---
+title: Fix Account API resource bug
+released_in_version: 1.7.7
+---

.hark/changes/2012-11-21_unknown_relax-version-constraint.change.md

@@ -0,0 +1,4 @@
+---
+title: "Relax the version constraint on multi_json (github issue #44)"
+released_in_version: 1.7.8
+---

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

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

.hark/changes/2013-02-04_unknown_add-support-passing.change.md

@@ -0,0 +1,4 @@
+---
+title: Add support for passing options when retrieving Stripe objects e.g., Stripe::Charge.retrieve({id:"foo", expand:["customer"]}) Stripe::Charge("foo") is still supported as well
+released_in_version: 1.7.10
+---

.hark/changes/2013-02-21_unknown_add-id-list.change.md

@@ -0,0 +1,4 @@
+---
+title: Add 'id' to the list of permanent attributes
+released_in_version: 1.7.11
+---

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

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

.hark/changes/2013-04-11_unknown_allow-transfers-createable.change.md

@@ -0,0 +1,4 @@
+---
+title: Allow Transfers to be createable
+released_in_version: 1.8.0
+---

.hark/changes/2013-04-19_unknown_add-support-specifying.change.md

@@ -0,0 +1,4 @@
+---
+title: Add support for specifying an API key when retrieving an upcoming invoice
+released_in_version: 1.8.1
+---

.hark/changes/2013-05-01_unknown_add-customer-upcominginvo.change.md

@@ -0,0 +1,4 @@
+---
+title: "Add an Customer#upcoming_invoice convenience method (github issue #65)"
+released_in_version: 1.8.2
+---

.hark/changes/2013-05-01_unknown_allow-updating-resources.change.md

@@ -0,0 +1,4 @@
+---
+title: "Allow updating resources without first retrieving them (github issue #60)"
+released_in_version: 1.8.2
+---

.hark/changes/2013-05-01_unknown_handle-low-memory.change.md

@@ -0,0 +1,4 @@
+---
+title: "Handle low-memory situations without throwing an exception (github issue #61)"
+released_in_version: 1.8.2
+---

.hark/changes/2013-05-01_unknown_use-tosym-instead.change.md

@@ -0,0 +1,4 @@
+---
+title: "Use to_sym instead of type checking for minor performance improvement (github issue #59)"
+released_in_version: 1.8.2
+---

.hark/changes/2013-05-06_unknown_fix-handling-per.change.md

@@ -0,0 +1,4 @@
+---
+title: "Fix handling of per-call API keys (github issue #67)"
+released_in_version: 1.8.3
+---

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

@@ -0,0 +1,4 @@
+---
+title: "Add support for new cards API (Stripe API version - 2013-07-05)"
+released_in_version: 1.8.4
+---

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

@@ -0,0 +1,4 @@
+---
+title: Add support for unsetting attributes by setting to nil. This permits unsetting email and description on customers and description on charges. Setting properties to a blank string is now an error.
+released_in_version: 1.8.5
+---

.hark/changes/2013-08-12_unknown_attempting-set-object.change.md

@@ -0,0 +1,4 @@
+---
+title: Attempting to set an object's id is now an error
+released_in_version: 1.8.5
+---

.hark/changes/2013-08-20_unknown_add-balance-balancetrans.change.md

@@ -0,0 +1,4 @@
+---
+title: Add Balance and BalanceTransaction resources
+released_in_version: 1.8.6
+---

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

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

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

@@ -0,0 +1,4 @@
+---
+title: Add support for metadata on resources
+released_in_version: 1.8.8
+---

.hark/changes/2013-11-14_unknown_fix-apiresourcet-use.change.md

@@ -0,0 +1,4 @@
+---
+title: Fix api_resource_test to not use returns as a way of testing rescue behavior
+released_in_version: 1.8.9
+---

.hark/changes/2013-11-14_unknown_fix-gemspec-dependencies.change.md

@@ -0,0 +1,4 @@
+---
+title: Fix gemspec dependencies so the gem doesn't break for Ruby 1.8 users
+released_in_version: 1.8.9
+---

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

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

.hark/changes/2014-01-29_unknown_allow-save-take.change.md

@@ -0,0 +1,4 @@
+---
+title: "Allow #save to take opts (for :expand)"
+released_in_version: 1.10.0
+---

.hark/changes/2014-01-29_unknown_fix-try-respondto.change.md

@@ -0,0 +1,4 @@
+---
+title: "Fix #try and #respond_to? on StripeObjects"
+released_in_version: 1.10.0
+---

.hark/changes/2014-01-29_unknown_replace-multijson-json.change.md

@@ -0,0 +1,4 @@
+---
+title: Replace multi_json with json
+released_in_version: 1.10.0
+---

.hark/changes/2014-01-29_unknown_support-multiple-subscription.change.md

@@ -0,0 +1,4 @@
+---
+title: Support for multiple subscriptions per customer
+released_in_version: 1.10.0
+---

.hark/changes/2014-01-29_unknown_testing-ruby-2.change.md

@@ -0,0 +1,4 @@
+---
+title: Testing ruby 2.1.0
+released_in_version: 1.10.0
+---

.hark/changes/2014-02-03_unknown_fix-marshaling-stripeobject.change.md

@@ -0,0 +1,4 @@
+---
+title: Fix marshaling of StripeObjects
+released_in_version: 1.10.1
+---

.hark/changes/2014-02-18_unknown_add-createsubscr-customer.change.md

@@ -0,0 +1,7 @@
+---
+title: Add create_subscription on Customer resources, so you can create
+released_in_version: 1.10.2
+---
+
+subscriptions without needing to retrieve the customer first (github
+issue #120)

.hark/changes/2014-04-09_unknown_implement-certificate-blacklisting.change.md

@@ -0,0 +1,4 @@
+---
+title: Implement certificate blacklisting
+released_in_version: 1.11.0
+---

.hark/changes/2014-04-09_unknown_update-included-ca.change.md

@@ -0,0 +1,4 @@
+---
+title: Update included ca bundles
+released_in_version: 1.11.0
+---

.hark/changes/2014-05-21_unknown_support-cards-recipients.change.md

@@ -0,0 +1,4 @@
+---
+title: Support for cards for recipients
+released_in_version: 1.12.0
+---

.hark/changes/2014-05-28_unknown_support-canceling-transfers.change.md

@@ -0,0 +1,4 @@
+---
+title: Support for canceling transfers
+released_in_version: 1.13.0
+---

.hark/changes/2014-06-17_unknown_add-metadata-refunds.change.md

@@ -0,0 +1,4 @@
+---
+title: Add metadata for refunds and disputes
+released_in_version: 1.14.0
+---

.hark/changes/2014-07-29_unknown_application-fee-refunds.change.md

@@ -0,0 +1,4 @@
+---
+title: Application Fee refunds now a list instead of array
+released_in_version: 1.15.0
+---

.hark/changes/2014-10-08_unknown_coupons-now-support.change.md

@@ -0,0 +1,4 @@
+---
+title: "Coupons now support update operations - useful for manipulating metadata"
+released_in_version: 1.16.0
+---

.hark/changes/2014-12-19_unknown_ability-send-idempotent.change.md

@@ -0,0 +1,4 @@
+---
+title: Ability to send idempotent requests
+released_in_version: 1.16.1
+---

.hark/changes/2014-12-19_unknown_ability-specify-stripe.change.md

@@ -0,0 +1,4 @@
+---
+title: Ability to specify stripe account as a header
+released_in_version: 1.16.1
+---

.hark/changes/2014-12-23_unknown_file-uploads-resource.change.md

@@ -0,0 +1,4 @@
+---
+title: File uploads resource was added (for uploading pdf or image documents for disputes)
+released_in_version: 1.17.0
+---

.hark/changes/2015-01-07_unknown_added-deauthorize-method.change.md

@@ -0,0 +1,4 @@
+---
+title: Added deauthorize method to Account object
+released_in_version: 1.17.1
+---

.hark/changes/2015-01-07_unknown_fixed-dependencies-ruby.change.md

@@ -0,0 +1,4 @@
+---
+title: Fixed dependencies for Ruby versions less than 1.9.3
+released_in_version: 1.17.1
+---

.hark/changes/2015-01-08_unknown_fixed-api-key.change.md

@@ -0,0 +1,4 @@
+---
+title: Fixed API key propagation for child resources
+released_in_version: 1.17.2
+---

.hark/changes/2015-01-12_unknown_fixed-api-key.change.md

@@ -0,0 +1,4 @@
+---
+title: "Fixed API key propagation for ApplicationFee#refund"
+released_in_version: 1.17.3
+---

.hark/changes/2015-01-21_unknown_added-support-making.change.md

@@ -0,0 +1,4 @@
+---
+title: Added support for making bitcoin charges through BitcoinReceiver source object
+released_in_version: 1.18.0
+---

.hark/changes/2015-02-15_unknown_account-retrieval-now.change.md

@@ -0,0 +1,4 @@
+---
+title: Account retrieval now optionally accepts an account ID
+released_in_version: 1.19.0
+---

.hark/changes/2015-02-15_unknown_better-support-passing.change.md

@@ -0,0 +1,4 @@
+---
+title: Better support for passing custom headers, like Stripe-Account, through requests
+released_in_version: 1.19.0
+---

.hark/changes/2015-02-15_unknown_support-new-transfers.change.md

@@ -0,0 +1,4 @@
+---
+title: Support for new Transfers /reversals endpoint
+released_in_version: 1.19.0
+---