Skip to content

Latest commit

 

History

History
45 lines (37 loc) · 3.37 KB

README.md

File metadata and controls

45 lines (37 loc) · 3.37 KB
Raw

prebid-js-external-js-template

This repo is a template for prebid.js adapters that would like to use external JavaScript in their Prebid.js Adapters. See Policy below for details.

Repo structure:

├── README.md
├── LICENSE                - license that governs the external source code
├── build                  - build related artifacts
├── dist                   - checked-in build files
│   ├── 0.0.1              - semantic versioned folder
│   │   ├── prod.js        - unminified build file
│   │   └── prod.min.js    - minified build file
│   └── prod.min.js        - minified current prod code
│   ├── prod.js            - unminified current prod code
└── src                    - source files
    └── code.js

Instructions

  1. Request that a Prebid.org core team member clone this repo into a separate company specific repo such as prebid-js-external-js-company_name.
  2. Once granted access to the new repo, upload your external JS source code into the /src.
  3. Add your build related items into the /build folder so that your source files can be built into minified and unminified prod files.
  4. Check in your built files under /dist/[version]/prod.js and /dist/[version]/prod.min.js and also at /dist/prod.min.js to indicate which file is currently prod.
  5. Use a git tag matching your semver version @ /dist/prod.min.js so that jsdelivr can point to a specific version.
  6. Update your LICENSE file as necessary.
  7. Update the README.md file that includes the maintainer's email address, a link to the Prebid.JS adapter that uses it, and a summary of the functionality provided by the code.
  8. Publish your CDN file using https://www.jsdelivr.com or alternatively a Prebid.org approved vendor. If using jsdelivr (preferred), files are automatically published via convention at https://cdn.jsdelivr.net/gh/<org>/<project>@<semver>/<file_path>.
  9. Use the published URL in step 8 above in your Prebid.js adapter submission.

Policy

Prebid.js adapter policy states no external JavaScript is allowed (see this link ). The following policy provides an exception to this rule if the conventions below are followed:

  1. Prebid.org creates a public Github repository with no license distribution constraints for external libraries. All code there is proprietary, with the committer being the IP owner.
  2. This repo, while owned by Prebid.org, will provide full admin access to the committers.
  3. The production URL that is committed inside the Prebid.js adapter needs to be hosted by https://www.jsdelivr.com or by a Prebid.org approved vendor.
    1. Prebid.org approved vendors must support the following:
      1. Local presence in major regions including: North and South America, EU, APAC.
      2. Must have local response time < 100ms for 90th percentile.
      3. Must include proper caching directive header such as: cache-control: max-age; etag; expires etc.
  4. The build process must be transparent and Prebid.org reserves the right to spot check and/or run a script to check published CDN checksums match the checked-in dist files.
  5. Prebid.org will indicate on the download page that a particular vendor downloads additional external JavaScript.