https://github.com/sambacha/action-dmap

solidity dependency management, a la carte
https://github.com/sambacha/action-dmap

dmap ethereum github-dependency package-manager smart-contracts solidity

Last synced: 8 days ago
JSON representation

solidity dependency management, a la carte

• Host: GitHub
• URL: https://github.com/sambacha/action-dmap
• Owner: sambacha
• Created: 2024-06-08T19:59:46.000Z (7 months ago)
• Default Branch: master
• Last Pushed: 2024-06-08T21:08:51.000Z (7 months ago)
• Last Synced: 2024-12-13T01:43:37.906Z (9 days ago)
• Topics: dmap, ethereum, github-dependency, package-manager, smart-contracts, solidity
• Language: TypeScript
• Homepage:
• Size: 5.86 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## GitHub Dependency Submission Documentation:

#### Endpoint Details:

1. **API Endpoint**: `/repos/{owner}/{repo}/dependency-graph/snapshots`

    - **Method**: POST

    - **Headers**:

        - `accept: application/vnd.github.v4+json`

        - `authorization: token `

#### Payload Structure:

The JSON payload to be submitted should conform to the following structure:

- **version**: An integer indicating the version of the snapshot format.

- **sha**: A string representing the commit SHA for which the snapshot applies.

- **ref**: A string representing the Git reference (e.g., refs/heads/main).

- **job**: A string uniquely identifying the job run.

- **detector**: An object containing details about the tool used to detect the dependencies:

    - **name**: The name of the tool.

    - **version**: The version of the tool.

    - **url**: The URL of the tool's documentation.

- **metadata** (optional): Additional information about the environment, job, scanner, and scan ID.

- **dependencies**: An array of objects representing dependencies, each containing:

    - **ref**: A string representing the reference to the dependency.

    - **metadata** (optional): Additional metadata about the dependency.

### JSON Format Specification (from the provided file `format.json`):

- Required properties: `version`, `sha`, `ref`, `job`, `detector`, and `dependencies`.

- `detector` object must contain `name`, `version`, and `url`.