Fix scorecard #452

finn-block · 2024-03-19T20:04:58Z

This seemingly fixes the scorecard analysis job. I'm not clear exactly what broke but it seems like the version we pinned can no longer talk to their online service. There are two changes:

bump the version of the action to latest
run the action in PRs to prove it works

github-actions · 2024-03-19T20:08:20Z

TBDocs Report

🛑 Errors: 0
⚠️ Warnings: 130

@web5/api

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

📄 File: ./packages/api/src/protocol.ts
⚠️ `extractor:typedoc:missing-reference`: ProtocolMetadata is referenced by Protocol._metadata but not included in the documentation.
⚠️ `extractor:typedoc:missing-docs`: Protocol._agent (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Protocol._metadata (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Protocol._protocolsConfigureMessage (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Protocol.send.__type.status (Property) does not have any documentation.

📄 File: ./packages/api/src/send-cache.ts
⚠️ `extractor:typedoc:missing-reference`: SendCache is referenced by Record._sendCache but not included in the documentation.

📄 File: ./packages/api/src/web5.ts
⚠️ `extractor:typedoc:missing-reference`: Web5Options is referenced by Web5.constructor.new Web5.options but not included in the documentation.
⚠️ `extractor:typedoc:missing-docs`: TechPreviewOptions.__type.dwnEndpoints (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Web5ConnectOptions.__type.connectedDid (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Web5.connect.__type.web5 (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Web5.connect.__type.did (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Web5.connectedDid (Property) does not have any documentation.

📄 File: ./packages/api/src/utils.ts
⚠️ `extractor:typedoc:missing-docs`: utils.dataToBlob.__type.dataBlob (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: utils.dataToBlob.__type.dataFormat (Property) does not have any documentation.

📄 File: ./packages/api/src/did-api.ts
⚠️ `extractor:typedoc:missing-docs`: DidApi.agent (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: DidApi.connectedDid (Property) does not have any documentation.

📄 File: ./packages/api/src/dwn-api.ts
⚠️ `extractor:typedoc:missing-docs`: ResponseStatus.__type.status (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ResponseStatus.__type.status.__type.code (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ResponseStatus.__type.status.__type.detail (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsConfigureRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsConfigureResponse.__type.protocol (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsQueryReplyEntry.__type.descriptor (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsQueryRequest.__type.from (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsQueryRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsQueryResponse.__type.protocols (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsCreateFromRequest.__type.author (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsCreateFromRequest.__type.data (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsCreateFromRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsCreateFromRequest.__type.record (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsDeleteRequest.__type.from (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsDeleteRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsQueryRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsQueryResponse.__type.records (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsReadRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsReadResponse.__type.record (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsWriteRequest.__type.data (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsWriteRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsWriteRequest.__type.store (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsWriteResponse.__type.record (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: DwnApi.agent (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: DwnApi.connectedDid (Property) does not have any documentation.

📄 File: ./packages/api/src/record.ts
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.author (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.connectedDid (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.encodedData (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.data (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.initialWrite (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.protocolRole (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.remoteOrigin (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordModel.__type.author (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordModel.__type.protocolRole (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordModel.__type.recordId (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.data (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.dataCid (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.dataSize (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.dateModified (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.datePublished (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.published (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.protocolRole (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._sendCache (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._agent (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._connectedDid (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._encodedData (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._readableStream (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._remoteOrigin (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._author (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._attestation (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._authorization (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._contextId (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._descriptor (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._encryption (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._initialWrite (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._initialWriteStored (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._initialWriteSigned (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._recordId (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._protocolRole (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record.data.__type.then (CallSignature) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record.data.__type.catch (CallSignature) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record.processRecord (CallSignature) does not have any documentation.

📄 File: ./packages/api/src/vc-api.ts
⚠️ `extractor:typedoc:missing-docs`: VcApi.agent (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VcApi.connectedDid (Property) does not have any documentation.

🔀 Misc.
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/agent#Web5Agent" in comment for Web5ConnectOptions.__type.agent. You may have wanted "@web5/agent!Web5Agent"
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/user-agent#Web5UserAgent" in comment for Web5ConnectOptions.__type.agent. You may have wanted "@web5/user-agent!Web5UserAgent"
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/agent#AppDataStore" in comment for Web5ConnectOptions.__type.appData. You may have wanted "@web5/agent!AppDataStore"
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/agent#AppDataStore" in comment for Web5ConnectOptions.__type.appData. You may have wanted "@web5/agent!AppDataStore"
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/agent#Web5Agent" in comment for Web5.connect. You may have wanted "@web5/agent!Web5Agent"
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/user-agent#Web5UserAgent" in comment for Web5.connect. You may have wanted "@web5/user-agent!Web5UserAgent"

@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

📄 File: ./packages/credentials/src/jwt.ts
⚠️ `extractor:typedoc:missing-docs`: JwtParseResult.__type.decoded (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: JwtParseResult.__type.encoded (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: JwtParseResult.__type.encoded.__type.header (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: JwtParseResult.__type.encoded.__type.payload (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: JwtParseResult.__type.encoded.__type.signature (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ParseJwtOptions.__type.jwt (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: SignJwtOptions.__type.signerDid (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: SignJwtOptions.__type.payload (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifyJwtOptions.__type.jwt (Property) does not have any documentation.

📄 File: ./packages/credentials/src/presentation-exchange.ts
⚠️ `extractor:typedoc:missing-docs`: PresentationDefinitionV2 (Interface) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Validated (TypeAlias) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: PresentationExchange (Class) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: PresentationExchange.resetPex (CallSignature) does not have any documentation.

📄 File: ./packages/credentials/src/verifiable-credential.ts
⚠️ `extractor:typedoc:missing-docs`: DEFAULT_VC_CONTEXT (Variable) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: DEFAULT_VC_TYPE (Variable) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredentialCreateOptions.__type.type (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredentialCreateOptions.__type.issuer (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredentialCreateOptions.__type.subject (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredentialCreateOptions.__type.data (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredentialCreateOptions.__type.issuanceDate (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredentialCreateOptions.__type.expirationDate (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredentialSignOptions.__type.did (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredential.verify.__type.issuer (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredential.verify.__type.subject (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredential.verify.__type.vc (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredential.type (GetSignature) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredential.issuer (GetSignature) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredential.subject (GetSignature) does not have any documentation.

📄 File: ./packages/credentials/src/verifiable-presentation.ts
⚠️ `extractor:typedoc:missing-docs`: DEFAULT_VP_TYPE (Variable) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentationCreateOptions.__type.holder (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentationCreateOptions.__type.vcJwts (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentationCreateOptions.__type.type (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentationCreateOptions.__type.additionalData (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentationSignOptions.__type.did (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentation.verify.__type.issuer (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentation.verify.__type.subject (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentation.verify.__type.vc (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentation.type (GetSignature) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentation.holder (GetSignature) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentation.verifiableCredential (GetSignature) does not have any documentation.

TBDocs Report Updated at 2024-03-19T21:47:54Z 246c3e0

codecov · 2024-03-19T20:09:46Z

Codecov Report

Merging #452 (246c3e0) into main (b6ab3bb) will decrease coverage by 0.02%.
The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #452      +/-   ##
==========================================
- Coverage   93.36%   93.34%   -0.02%     
==========================================
  Files          80       80              
  Lines       23968    23968              
  Branches     1916     1916              
==========================================
- Hits        22377    22374       -3     
- Misses       1548     1551       +3     
  Partials       43       43

Components	Coverage Δ
agent	`88.72% <ø> (ø)`
api	`97.11% <ø> (-0.19%)`	⬇️
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% <ø> (ø)`

.github/workflows/scorecard.yml

finn-block changed the title ~~[attempt to] Fix scorecard~~ Fix scorecard Mar 19, 2024

finn-block force-pushed the fix-scorecard branch from a2cf548 to 6ffe0ff Compare March 19, 2024 20:07

finn-block marked this pull request as ready for review March 19, 2024 20:08

finn-block requested review from frankhinek, csuwildcat and mistermoe as code owners March 19, 2024 20:08

finn-block force-pushed the fix-scorecard branch from 6ffe0ff to c80bf73 Compare March 19, 2024 20:15

leordev reviewed Mar 19, 2024

View reviewed changes

.github/workflows/scorecard.yml Outdated Show resolved Hide resolved

bump OSSF Scorecard action

246c3e0

finn-block force-pushed the fix-scorecard branch from c80bf73 to 246c3e0 Compare March 19, 2024 21:44

leordev approved these changes Mar 19, 2024

View reviewed changes

frankhinek approved these changes Mar 20, 2024

View reviewed changes

frankhinek merged commit 5f69982 into main Mar 20, 2024
32 checks passed

frankhinek deleted the fix-scorecard branch March 20, 2024 04:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix scorecard #452

Fix scorecard #452

finn-block commented Mar 19, 2024 •

edited

Loading

github-actions bot commented Mar 19, 2024 •

edited

Loading

codecov bot commented Mar 19, 2024 •

edited

Loading

Fix scorecard #452

Fix scorecard #452

Conversation

finn-block commented Mar 19, 2024 • edited Loading

github-actions bot commented Mar 19, 2024 • edited Loading

@web5/api

@web5/crypto

@web5/crypto-aws-kms

@web5/dids

@web5/credentials

codecov bot commented Mar 19, 2024 • edited Loading

Codecov Report

finn-block commented Mar 19, 2024 •

edited

Loading

github-actions bot commented Mar 19, 2024 •

edited

Loading

codecov bot commented Mar 19, 2024 •

edited

Loading