Releases: Open-Cap-Table-Coalition/Open-Cap-Format-OCF
v1.2.0
Overview
This release is hopefully the first in a series of regular, quarterly releases. In addition to a number of fixes, this version includes some notable new features:
- We've added a financing object which can be used to link transactions to a financing event or group of related transactions - e.g. a note financing or venture round.
- We've added a document object which can be used to link events to origin documents - e.g. a Stock Purchase Agreement and resulting issuances.
- Stock plans now support multiple stock class ids
- Better handling of warrants with ambiguous exercise amounts
What's Changed
- Issue 415 authorized share count by @arthur-clara in #418
- Upgrade to Latest Node LTS by @JSv4 in #421
- Added Early Exercise Flag Field on Equity Compensation Issuance Event by @JSv4 in #428
- Provide for Warrant Issuances with Min, Max, Estimated, Unspecified or Indetermine Quantities by @JSv4 in #426
- Roll schema version to 1.1.1-alpha+main by @pjohnmeyer in #431
- Issue 419 adding optional stockholder approval date by @arthur-clara in #433
- Add Valuation Based Conversion Mechanism for Warrants by @JSv4 in #427
- fix: Updated quantity source type to live under the enums package instead of the types package by @lavens in #456
- removes unused package json by @osis in #463
- updates copyright to 2024 by @osis in #462
- bumps PyYaml to 6.0.1 by @osis in #466
- reorganizes package json to clarify the script scope by @osis in #465
- removes home links from all pages by @osis in #467
- fixing bug related to Issue #457 by @sachin-shrestha in #469
- Expand the Awesome OCF Projects List by @JSv4 in #472
- adds some context around the review cadence for PRs in the PR template by @osis in #473
- remove duplicated URI for file_type lookup map by @jacobyavis in #490
- feat: Added Financing object that can be referenced by Issuance trans… by @lavens in #478
- feat: Update stock plan to support multiple stock class ids by @lavens in #477
- improve validator output to be more useful to developers by @jacobyavis in #485
- Fix URL typo in license by @pjohnmeyer in #482
- Hard-wrap Markdown files w/ Prettier by @pjohnmeyer in #488
- Improved validation for adding new schemas by @jacobyavis in #491
- Financing bug fix and schema update by @lavens in #494
- Regenerate documentation by @pjohnmeyer in #499
- Fix typo in description field by @mrosendin in #495
- Changing phone number validation pattern to allow extensions by @sachin-shrestha in #498
- Add document describing our versioning policy by @pjohnmeyer in #487
- Fix Conversion Diagram by @JSv4 in #512
- Mkdocs Publish Only on Release or Manual Trigger by @JSv4 in #511
- add schemas to support attaching an exact array of vestings to any issuances with vesting (as an option to replace the need for vesting_terms_id) by @jacobyavis in #515
- add a schema for a Documents file (paths only) to be included in OCF by @jacobyavis in #497
- Fix "Compatibility Wrapper" object docs written to wrong part of tree by @JSv4 in #518
New Contributors
- @lavens made their first contribution in #456
- @osis made their first contribution in #463
- @sachin-shrestha made their first contribution in #469
- @mrosendin made their first contribution in #495
Full Changelog: v1.1.0...v1.2.0
v1.1.0 Release
This is our first release with schema IDs that are accessible at https://schema.opencaptablecoalition.com, e.g. https://schema.opencaptablecoalition.com/v/1.1.0/files/OCFManifestFile.schema.json or https://schema.opencaptablecoalition.com/v/1.1.0/objects/Issuer.schema.json.
Schema Changes
- Creation of capitalization definition rules based on issue #357. by @arthur-clara in #401
- Add RSA Support by @JSv4 in #396
- Update to the contact info type inside the Stakeholder object by @arthur-clara in #400
- Make
ocf_version
const in OCF Manifest File by @pjohnmeyer in #408 - Added proposal to give stock plans a clear default rule on what happe… by @JSv4 in #380
- [Enhancement] - Add draft transaction to return plan securities' shares to pool by @JSv4 in #381
- Revise PlanSecurity to Permit Plan-less Options and Incorporate Additional Type Enums by @JSv4 in #397
Other Changes
- Make schemas available by @xudiera in #351
- Fix unit tests by @xudiera in #358
- Quickstart zipfile will contain required initial_shares property by @naveedn in #383
- Naveedn bugfix broken urls by @naveedn in #385
- Added new script generate-release-docs by @xudiera in #371
- Removing deprecated code from EnforceCopyrightNotices by @xudiera in #395
- Validate obj against obj_type schema by @naveedn in #392
- Require "--tag" argument when generating release docs by @pjohnmeyer in #403
- Removed test-script.js by @xudiera in #399
- Support both $id formats in doc generator by @pjohnmeyer in #406
- add PROJECTS.md and link to it from README.md by @dan-pulley in #366
Full Changelog: v1.0.0...v1.1.0
v1.0.0 Release
What's Changed
- Updates title for two classes to reflect actual object by @naveedn in #282
- Adds MFN (most favored nation) clause to NoteConversionMechanism by @naveedn in #290
- Fixes Windows compatibility for docs generator by @xudiera in #285
- Remove references to base by @harryplumer in #286
- add exit multiple to safe conversions by @dan-pulley in #298
- Added scripts to run tests on Windows by @xudiera in #297
- Add Transfer Documentation / How-To by @JSv4 in #296
- Set npm to ~8.19 in package engines by @pjohnmeyer in #307
- add new type InterestRate and allow specifying an array of these on the NoteConversionMechanism by @jacobyavis in #304
- Remove
current_
prefix from the Stock Plancurrent_shared_reserved
field by @JSv4 in #310 - Add Stock Plan-level Pool Adjustment Transaction by @JSv4 in #309
- Added
conversion_price
field to RatioConversionMechanism.schema.json by @JSv4 in #306 - Revamp Document Generator and Structure for MkDocs by @JSv4 in #326
- Doc Generator Cleanup Fixes by @JSv4 in #330
- [Enhancement] Add a StockClassConversionRatioAdjustment Transaction by @JSv4 in #303
- edit the contributor's guide to remove or fix broken links and ensure all included sentences are relevant to OCF by @jacobyavis in #335
- Add VestingAcceleration transaction by @pjohnmeyer in #319
- add ultra minimal issuance walkthrough by @dan-pulley in #311
- Changed Jurisdiction Field in SecurityExemption to a Plain String by @JSv4 in #341
- Add
StockClassAuthorizedSharesAdjustment
Event by @JSv4 in #340 - Add
ShareNumberRange
Type andshare_numbers_issued
field toStockIssuance
by @JSv4 in #339 - Correct File Extensions in Sample Manifest File and Delete Old, Unused Sample Directory by @JSv4 in #342
- Fix Typo in ConvertibleConversion
capitalization_definition
field description by @JSv4 in #338 - Remove PreReleaseOmission by @JSv4 in #332
- Add Pre and Post Flavors to SAFEConversionMechanism by @JSv4 in #331
- Avoid running the publish workflow on new PRs by @Sumukh in #344
- Add Stock Class ID to Valuation object by @Sumukh in #343
- Update OCF Versions for Stable Release by @JSv4 in #348
- Create Option Tutorial by @JSv4 in #347
- Add Vesting Docs by @pjohnmeyer in #346
- Add Mermaid Rendering to MkDocs by @JSv4 in #350
- Add Detailed Terminal Transaction Guides by @JSv4 in #345
New Contributors
- @naveedn made their first contribution in #282
- @harryplumer made their first contribution in #286
- @dan-pulley made their first contribution in #298
- @Sumukh made their first contribution in #344
Full Changelog: v1.0.0-b3...v1.0.0
v1.0.0-beta3 Release
This is our third public preview release. Our next release date is not yet set.
What's Changed
Schema changes
- Revise the Security Release schema to use a minimal set of fields, similar to the Security Exercise schema by @jacobyavis in #268
- Make board_approval_date nullable on StockClass.schema.json by @xudiera in #276
Development changes
New Contributors
Full Changelog: v1.0.0-b2...v1.0.0-b3
v1.0.0-beta2 Release
Second Public Preview Release
This is our first follow-up release. Our next public preview release is planned for 11 October.
Key Changes:
- Repurchase transactions now have a
balance_security_id
instead ofresulting_security_ids
. Fixes #263 (PR #267).
Full Changelog: v1.0.0-b1...v1.0.0-b2
v1.0.0-beta.1 Release
First Public Preview Release
After thousands (probably, we lost count 😆 ) of man-hours and almost a year of development within the Technical Working Group, the Open Cap Table Coalition is thrilled to be able to release this public beta of the Open Cap Table Format (OCF).
This version is the product of:
- The original substantive data points identified by the Steering Committee as necessary to fully-describe a capitalization table;
- A JSONSchema-based data standard developed by the Technical Working Group, and
- Dozens of comments submitted by various member organizations over the course of a "member review" comment period that started in February on the alpha3 version.
- Validation work by a number of member organizations to ensure they can successfully export their data model to OCF.
Key Features:
- Event-based architecture capturing key lifecycle events for all of our security types.
- Logic-tree-based vesting structure that can express complex and arbitrary vesting arrangements, including mixed time and event-based vesting conditions
- Samples for all OCF object types.
- Documentation updates.
Please take a moment to review the README and browse the linked, auto-generated documentation pages.
Full Changelog: v1.0.0-alpha.3...v1.0.0-beta.1
v1.0.0-alpha.3
Internal preview release for the Coalition membership.
Includes a number of new features and enhancements:
- Full support for transaction histories for our four core security types using an event-driven architecture
- Multi-file and compressible .ocf file format
- Repo validation actions for schemas and examples
- We moved from Python to JavaScript for our tooling and validations
- New auto-generated documentation produced by our new document generator. Incudes OCF-specific headers and descriptions as well as examples for all objects.
Full Changelog: v1.0.0-alpha.2...v1.0.0-alpha.3
v1.0.0-alpha.2
Preview release of the OCF schemas covering the snapshot only.