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,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/2012-02-04_unknown_parameters-value-none.change.md

@@ -0,0 +1,4 @@
+---
+title: Parameters with value None are no longer included in API requests
+released_in_version: 1.6.1
+---

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

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

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

@@ -0,0 +1,4 @@
+---
+title: Add new stripe.Transfer 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-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.7.0
+---

.hark/changes/2012-05-21_unknown_prefer-app-engine.change.md

@@ -0,0 +1,4 @@
+---
+title: Prefer App Engine's urlfetch over requests, as that's the only thing that will work in App Engine's environment. Previously, if requests was available in the App Engine environment, we would attempt to use it.
+released_in_version: 1.7.1
+---

.hark/changes/2012-05-31_unknown_fix-bug-would.change.md

@@ -0,0 +1,4 @@
+---
+title: "Fix a bug that would cause nested objects to be mis-rendered in __str__ and __repr__ methods (github issues #17, #18)"
+released_in_version: 1.7.2
+---

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

@@ -0,0 +1,4 @@
+---
+title: Add new stripe.Account resource
+released_in_version: 1.7.3
+---

.hark/changes/2012-08-17_unknown_remove-uncapturedch-tests.change.md

@@ -0,0 +1,4 @@
+---
+title: Remove uncaptured_charge tests (this has been deprecated from the API).
+released_in_version: 1.7.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.7.4
+---

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

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

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

@@ -0,0 +1,4 @@
+---
+title: Add support for new List objects
+released_in_version: 1.7.5
+---

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

.hark/changes/2012-12-18_unknown_update-requests-version.change.md

@@ -0,0 +1,4 @@
+---
+title: "Update requests version check to work with requests 1.x.x (github issue #24)"
+released_in_version: 1.7.7
+---

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

.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("foo", params={"expand":["customer"]})
+released_in_version: 1.7.9
+---

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

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

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

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

@@ -0,0 +1,4 @@
+---
+title: Allow transfers to be creatable
+released_in_version: 1.8.0
+---

.hark/changes/2013-04-25_unknown_support-python-3.change.md

@@ -0,0 +1,4 @@
+---
+title: "Support for Python 3 (github issue #32)"
+released_in_version: 1.9.0
+---

.hark/changes/2013-05-03_unknown_remove-id-list.change.md

@@ -0,0 +1,4 @@
+---
+title: Remove 'id' from the list of permanent attributes
+released_in_version: 1.9.1
+---

.hark/changes/2013-07-12_unknown_add-support-multiple.change.md

@@ -0,0 +1,4 @@
+---
+title: Add support for multiple cards API
+released_in_version: 1.9.2
+---

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

@@ -0,0 +1,6 @@
+---
+title: Add support for unsetting attributes by setting to None.
+released_in_version: 1.9.3
+---
+
+Setting properties to a blank string is now an error.

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

@@ -0,0 +1,4 @@
+---
+title: Add stripe.Balance and stripe.BalanceTransaction resources
+released_in_version: 1.9.4
+---

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

.hark/changes/2013-10-08_unknown_fix-issue-support.change.md

@@ -0,0 +1,4 @@
+---
+title: Fix issue with support for closing disputes.
+released_in_version: 1.9.6
+---

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

@@ -0,0 +1,4 @@
+---
+title: Add support for metadata.
+released_in_version: 1.9.7
+---

.hark/changes/2013-10-17_unknown_removed-incorrect-test.change.md

@@ -0,0 +1,4 @@
+---
+title: Removed incorrect test.
+released_in_version: 1.9.8
+---

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

@@ -0,0 +1,4 @@
+---
+title: Add stripe.ApplicationFee resource
+released_in_version: 1.10.8
+---

.hark/changes/2013-12-05_unknown_abstracted-http-library.change.md

@@ -0,0 +1,4 @@
+---
+title: Abstracted http library selection and use from the `APIRequestor` into `stripe.http_client`
+released_in_version: 1.11.0
+---

.hark/changes/2013-12-05_unknown_added-extensive-unit.change.md

@@ -0,0 +1,4 @@
+---
+title: Added extensive unit tests
+released_in_version: 1.11.0
+---

.hark/changes/2013-12-05_unknown_extended-functional-test.change.md

@@ -0,0 +1,4 @@
+---
+title: Extended functional test coverage
+released_in_version: 1.11.0
+---

.hark/changes/2013-12-05_unknown_pep8ified-codebase-enforced.change.md

@@ -0,0 +1,4 @@
+---
+title: PEP8ified the codebase and enforced with a test.
+released_in_version: 1.11.0
+---

.hark/changes/2013-12-05_unknown_previousmeta-attribute-resources.change.md

@@ -0,0 +1,5 @@
+---
+title: The `previous_metadata` attribute on resources is now protected.
+section: Backwards incompatible changes
+released_in_version: 1.11.0
+---

.hark/changes/2013-12-05_unknown_proper-encoding-timezone.change.md

@@ -0,0 +1,4 @@
+---
+title: Proper encoding of timezone aware datetimes
+released_in_version: 1.11.0
+---

.hark/changes/2013-12-05_unknown_refactored-code-modules.change.md

@@ -0,0 +1,4 @@
+---
+title: Refactored code into modules and out of stripe/__init__.py
+released_in_version: 1.11.0
+---

.hark/changes/2013-12-05_unknown_refactored-stripeobject-inherit.change.md

@@ -0,0 +1,4 @@
+---
+title: Refactored `StripeObject` to inherit from `dict` and avoid direct access of `__dict__`.
+released_in_version: 1.11.0
+---

.hark/changes/2013-12-05_unknown_timezone-aware-datetime.change.md

@@ -0,0 +1,5 @@
+---
+title: Timezone aware `datetime` objects passed to the API will now be encoded in a way that does not depend on the local system time.  If you are passing timezone-aware datetimes to our API and your server time is not already in UTC, this will change the value passed to our API.
+section: Backwards incompatible changes
+released_in_version: 1.11.0
+---

.hark/changes/2013-12-05_unknown_todict-values-methods.change.md

@@ -0,0 +1,6 @@
+---
+title: The `to_dict` and `values` methods on resources no longer recursively convert objects to plain `dict`s.  All resources now inherit from `dict` but are functionally different in that you cannot set a value to an empty string and cannot delete items.
+semver_level: major
+section: Backwards incompatible changes
+released_in_version: 1.11.0
+---

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

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

.hark/changes/2014-03-13_unknown_added-license-other.change.md

@@ -0,0 +1,4 @@
+---
+title: Added license and other metadata in setup.py
+released_in_version: 1.12.1
+---

.hark/changes/2014-03-13_unknown_fix-repr-python.change.md

@@ -0,0 +1,4 @@
+---
+title: Fix `__repr__` in Python 3
+released_in_version: 1.12.1
+---

.hark/changes/2014-03-13_unknown_fix-syntax-errors.change.md

@@ -0,0 +1,4 @@
+---
+title: Fix syntax errors in setup.py metadata
+released_in_version: 1.12.2
+---

.hark/changes/2014-03-13_unknown_support-pickling-responses.change.md

@@ -0,0 +1,4 @@
+---
+title: Support pickling of responses
+released_in_version: 1.12.1
+---

.hark/changes/2014-04-09_unknown_add-certificate-blacklist.change.md

@@ -0,0 +1,4 @@
+---
+title: Add certificate blacklist for CVE-2014-0160 mitigation
+released_in_version: 1.13.0
+---

.hark/changes/2014-04-09_unknown_don-t-rely.change.md

@@ -0,0 +1,4 @@
+---
+title: Don't rely on SNI support in integration tests
+released_in_version: 1.14.0
+---

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

@@ -0,0 +1,4 @@
+---
+title: Update bundled ca-certificates
+released_in_version: 1.13.0
+---

.hark/changes/2014-04-09_unknown_use-der-encoded.change.md

@@ -0,0 +1,4 @@
+---
+title: Use DER encoded certificate for checksumming
+released_in_version: 1.14.0
+---

.hark/changes/2014-05-19_unknown_disable-loading-ssl.change.md

@@ -0,0 +1,4 @@
+---
+title: Disable loading the ssl module on the Google App Engine dev server.
+released_in_version: 1.14.1
+---

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

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

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

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

.hark/changes/2014-06-10_unknown_remove-official-support.change.md

@@ -0,0 +1,4 @@
+---
+title: Remove official support for Python 2.5
+released_in_version: 1.17.0
+---

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

@@ -0,0 +1,4 @@
+---
+title: Add metadata for disputes and refunds
+released_in_version: 1.18.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.19.0
+---

.hark/changes/2014-10-23_unknown_remove-redundant-manual.change.md

@@ -0,0 +1,4 @@
+---
+title: Remove redundant manual SSL blacklist preflight check
+released_in_version: 1.19.1
+---

.hark/changes/2014-12-23_unknown_adding-support-file.change.md

@@ -0,0 +1,4 @@
+---
+title: Adding support for file uploads resource
+released_in_version: 1.20.0
+---

.hark/changes/2015-01-07_unknown_adding-bitcoin-receiver.change.md

@@ -0,0 +1,4 @@
+---
+title: Adding bitcoin receiver and transaction objects
+released_in_version: 1.20.1
+---

.hark/changes/2015-01-21_unknown_remove-support-top.change.md

@@ -0,0 +1,4 @@
+---
+title: Remove support for top-level bitcoin transactions
+released_in_version: 1.20.2
+---

.hark/changes/2015-02-19_unknown_added-bitcoin-receiver.change.md

@@ -0,0 +1,4 @@
+---
+title: Added Bitcoin Receiver update and delete methods
+released_in_version: 1.21.0
+---

.hark/changes/2015-03-22_unknown_added-methods-updating.change.md

@@ -0,0 +1,4 @@
+---
+title: Added methods for updating and saving arrays of objects
+released_in_version: 1.22.0
+---

.hark/changes/2015-03-30_unknown_pass-stripeaccoun-balance.change.md

@@ -0,0 +1,4 @@
+---
+title: Pass `stripe_account` to Balance.retrieve
+released_in_version: 1.22.1
+---

.hark/changes/2015-04-08_unknown_fix-saving-manage.change.md

@@ -0,0 +1,4 @@
+---
+title: Fix saving manage accounts
+released_in_version: 1.22.2
+---

.hark/changes/2015-06-04_unknown_fix-saving-additionalow.change.md

@@ -0,0 +1,4 @@
+---
+title: Fix saving `additional_owners` on managed accounts
+released_in_version: 1.22.3
+---

.hark/changes/2015-07-06_unknown_include-response-headers.change.md

@@ -0,0 +1,4 @@
+---
+title: Include response headers in exceptions
+released_in_version: 1.23.0
+---

.hark/changes/2015-08-03_unknown_added-dispute-listing.change.md

@@ -0,0 +1,4 @@
+---
+title: Added dispute listing and retrieval
+released_in_version: 1.24.0
+---

.hark/changes/2015-08-03_unknown_managed-accounts-can.change.md

@@ -0,0 +1,4 @@
+---
+title: Managed accounts can now be deleted
+released_in_version: 1.24.0
+---

.hark/changes/2015-08-05_unknown_fix-error-handling.change.md

@@ -0,0 +1,4 @@
+---
+title: Fix error handling for Python 2.6
+released_in_version: 1.24.1
+---

.hark/changes/2015-08-17_unknown_added-refund-listing.change.md

@@ -0,0 +1,4 @@
+---
+title: Added refund listing, creation and retrieval
+released_in_version: 1.25.0
+---

.hark/changes/2015-09-11_unknown_add-support-new.change.md

@@ -0,0 +1,4 @@
+---
+title: Add support for new 429 rate limit response
+released_in_version: 1.26.0
+---