chore: release v1

[rflechtner]

🚧 WIP 🚧

Release branch for V1 of the SDK.

TODOs before release:

• Figure out what versions to use for non-V1'd sub-packages. We should leave some room for legacy support releases, so I went for 0.100.0 now, but can be discussed.
  • We have major breaking changes only on the following packages:
    • @kiltprotocol/did
    • @kiltprotocol/types (some types removed)
    • SDKErrors on @kiltprotocol/utils
    • @kiltprotocol/vc-export (but is planned to be renamed)
• Choose versioning strategy for sub-packages. E.g., pinning or tilde imports?
• Consider making other package imports and polkadot packages peer dependencies on sub-packages
• rename @kiltprotocol/vc-export (chore: rename vc export package #828)

[rflechtner]

Release Candidate Checklist

1. Release rc-1
   1. Create a release branch by branching off from develop.
   2. [VERY IMPORTANT] Update type definitions and api augmentation to match the targeted Spiritnet release or rc
      • In the augment-api package's definitions.ts, make sure to import the version of the type definitions matching the targeted runtime version (e.g. for runtime version 10900, import types10900).
      • Update the spiritnet.json metadata to the metadata of the targeted runtime.
      • Run type generation scripts, check for type errors (yarn check) and run tests.
      • If everything looks good, commit all changes in a single commit.
   3. Run yarn run set:version to update all public packages with the specified version. ⚠️ NOTE: We are using divergent versioning now, so the V1 packages will have to be updated manually afterwards
   4. Commit the changes in the package.json files
   5. Create and publish a release on github targeting the release branch.
      • Make sure to check "this is a pre-release".
      • Have github create a new tag (1.0.0-alpha.1) on release.
   6. Publish the release candidate to npm using the corresponding github action, selecting the tag just created as the target.
2. Communicate RC release and that applications should be tested against it on
   • Slack
   • Discord
3. Test docs/workshop against the rc version using Peregrine
   • Readmes
   • Getting-Started Guide
   • Workshop
4. Test dev Sporran against the rc version
5. Test dev SocialKYC against the rc version
6. Test DIDSign against rc version
7. Test Cookbook recipes against rc version
8. Test DID driver & stakeboard against rc version (if applicable)
9. Do SDK bundle tests (for testing browser / webpack compatibility)
10. Fix any issues, and repeat from step 1 increased rc-x to the next version
    • If fixes are needed in docs or apps, hold the release of them until the official sdk version is released

[ntn-x2]

So we're only exporting the root SDK as v1?

[ntn-x2]

So we're only exporting the root SDK as v1?

[rflechtner]

So we're only exporting the root SDK as v1?

For now, yes