Setup Changesets

[leordev]

• Introduces and setup Changesets
• Whole information and details were added on the CONTRIBUTING.md file
• Automation for preview packages on every merged changeset to main under the tag next
• Since @web5/api requires a release orchestration with the community and a series of checks through a release template checklist, version bumps on changesets PRs are disabled by default; when ready to release trigger the release workflow manually with the API flag or just label the Version Packages PR with the api-release label. (Also added to the contributing file)

TODO before merging:

• Create the api-release label

TODO after merging:

• Install Changesets bot

Working evidence in my forked repo:

• Git Tags and Releases with Changelog notes:
  • https://github.com/leordev/web5-js/tags
  • https://github.com/leordev/web5-js/releases
• npm.js versions with preview next tags being published:
  • https://www.npmjs.com/package/@leordev-web5/api?activeTab=versions
• Changesets Version Package PR example
  • Version Packages leordev/web5-js#3
• PR with Changesets bot notification:
  • test patching some packages leordev/web5-js#2

[codecov]

Codecov Report

Merging #416 (f89c98b) into main (5f69982) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #416   +/-   ##
=======================================
  Coverage   93.34%   93.34%           
=======================================
  Files          80       80           
  Lines       23968    23968           
  Branches     1916     1916           
=======================================
  Hits        22374    22374           
  Misses       1551     1551           
  Partials       43       43           

Components	Coverage Δ
agent	88.72% <ø> (ø)
api	97.11% <ø> (ø)
common	98.68% <ø> (ø)
credentials	94.75% <ø> (ø)
crypto	93.81% <ø> (ø)
dids	97.51% <ø> (ø)
identity-agent	56.81% <ø> (ø)
crypto-aws-kms	100.00% <ø> (ø)
proxy-agent	58.43% <ø> (ø)
user-agent	55.22% <ø> (ø)

[frankhinek]

Good discussion with @leordev today to answer the few remaining questions. Think we're close to getting this merged once @leordev tests a few remaining things and updates the PR.

[github-actions]

TBDocs Report

🛑 Errors: 0
⚠️ Warnings: 4

@web5/api

• Project entry file: packages/api/src/index.ts

@web5/crypto

• Project entry file: packages/crypto/src/index.ts

@web5/crypto-aws-kms

• Project entry file: packages/crypto-aws-kms/src/index.ts

📄 File: ./packages/crypto-aws-kms/src/ecdsa.ts
⚠️ extractor:typedoc:missing-docs: EcdsaAlgorithm (Class) does not have any documentation.

📄 File: ./packages/crypto-aws-kms/src/key-manager.ts
⚠️ extractor:typedoc:missing-docs: AwsKeyManager (Class) does not have any documentation.

📄 File: ./packages/crypto-aws-kms/src/utils.ts
⚠️ extractor:typedoc:missing-docs: getKeySpec (CallSignature) does not have any documentation.

🔀 Misc.
⚠️ extractor:typedoc:invalid-link: Failed to resolve link to "@web5/crypto#Secp256k1.adjustSignatureToLowS | here" in comment for EcdsaAlgorithm.sign. You may have wanted "@web5/crypto!Secp256k1.adjustSignatureToLowS | here"

@web5/dids

• Project entry file: packages/dids/src/index.ts

@web5/credentials

• Project entry file: packages/credentials/src/index.ts

---

TBDocs Report Updated at 2024-04-03T15:20:39Z 6989705

[codecov-commenter]

Codecov Report

Merging #416 (6989705) into main (070d892) will increase coverage by 0.01%.
Report is 1 commits behind head on main.
The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #416      +/-   ##
==========================================
+ Coverage   90.54%   90.55%   +0.01%     
==========================================
  Files         112      112              
  Lines       29085    29085              
  Branches     2078     2078              
==========================================
+ Hits        26335    26338       +3     
+ Misses       2715     2712       -3     
  Partials       35       35              

Components	Coverage Δ
agent	78.83% <ø> (ø)
api	97.89% <ø> (+0.15%)	⬆️
common	98.68% <ø> (ø)
credentials	95.21% <ø> (ø)
crypto	93.81% <ø> (ø)
dids	97.65% <ø> (ø)
identity-agent	96.70% <ø> (ø)
crypto-aws-kms	100.00% <ø> (ø)
proxy-agent	96.70% <ø> (ø)
user-agent	96.70% <ø> (ø)