Updated master

.devcontainer/devcontainer.json

@@ -0,0 +1,11 @@
+{
+  "image": "mcr.microsoft.com/devcontainers/jekyll:2",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "rebornix.Ruby",
+        "DavidAnson.vscode-markdownlint"
+      ]
+    }
+  }
+}

.github/pull_request_template.md

@@ -4,9 +4,11 @@
 
 Please make the PR writeable. This allows us to fix typos, grammar and linting errors ourselves, which makes
 merging and reviewing a lot faster for everybody.
+
+⚠️ The documentation is merged after the related code changes are merged and release ⚠️
 -->
 
 ## 🏷 Type of documentation
 <!-- Remove items that don't apply and/or select an item by changing [ ] to [x] -->
 - [ ] new bid adapter
 - [ ] update bid adapter

.github/workflows/ci.yml

@@ -15,15 +15,15 @@ jobs:
     name: run markdownlint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: tj-actions/changed-files@v41
+      - uses: tj-actions/changed-files@v46
         id: changed-files
         with:
           files: '**/*.md'
           separator: ","
-      - uses: DavidAnson/markdownlint-cli2-action@v15
+      - uses: DavidAnson/markdownlint-cli2-action@v16
         if: steps.changed-files.outputs.any_changed == 'true'
         with:
           globs: "${{ steps.changed-files.outputs.all_changed_files }},!_includes"

.github/workflows/code-path-changes.yml

@@ -0,0 +1,37 @@
+name: Notify Code Path Changes
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+    paths:
+      - '**'
+
+env:
+  OAUTH2_CLIENT_ID: ${{ secrets.OAUTH2_CLIENT_ID }}
+  OAUTH2_CLIENT_SECRET: ${{ secrets.OAUTH2_CLIENT_SECRET }}
+  OAUTH2_REFRESH_TOKEN: ${{ secrets.OAUTH2_REFRESH_TOKEN }}
+  GITHUB_REPOSITORY: ${{ github.repository }}
+  GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }}
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+permissions:
+  contents: read
+
+jobs:
+  notify:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install dependencies
+        run: npm install axios nodemailer
+
+      - name: Run Notification Script
+        run: |
+          node .github/workflows/scripts/send-notification-on-change.js

.github/workflows/scripts/codepath-notification

@@ -0,0 +1,18 @@
+# when a changed file paths matches the regex, send an alert email
+# structure of the file is:
+#
+# javascriptRegex : email address
+#
+# For example, in the Prebid docs repo, the file pattern is generally
+#
+# /dev-docs/bidders/BIDDERCODE.md
+#
+# The aim is to find a minimal set of regex patterns that matches any file in these paths
+
+/dev-docs/bidders/rubicon : header-bidding@magnite.com
+/dev-docs/bidders/ix : pdu-supply-prebid@indexexchange.com
+/dev-docs/bidders/appnexus|/dev-docs/bidders/msft : prebid@microsoft.com
+/dev-docs/bidders/pubmatic : header-bidding@pubmatic.com
+/dev-docs/bidders/openx : prebid@openx.com
+/dev-docs/bidders/teads : tech-ssp-video@teads.tv
+/dev-docs/bidders/kargo : kraken@kargo.com

.github/workflows/scripts/send-notification-on-change.js

@@ -0,0 +1,139 @@
+// send-notification-on-change.js
+//
+// called by the code-path-changes.yml workflow, this script queries github for
+// the changes in the current PR, checks the config file for whether any of those
+// file paths are set to alert an email address, and sends email to multiple
+// parties if needed
+
+const fs = require('fs');
+const path = require('path');
+const axios = require('axios');
+const nodemailer = require('nodemailer');
+
+async function getAccessToken(clientId, clientSecret, refreshToken) {
+  try {
+    const response = await axios.post('https://oauth2.googleapis.com/token', {
+      client_id: clientId,
+      client_secret: clientSecret,
+      refresh_token: refreshToken,
+      grant_type: 'refresh_token',
+    });
+    return response.data.access_token;
+  } catch (error) {
+    console.error('Failed to fetch access token:', error.response?.data || error.message);
+    process.exit(1);
+  }
+}
+
+(async () => {
+  const configFilePath = path.join(__dirname, 'codepath-notification');
+  const repo = process.env.GITHUB_REPOSITORY;
+  const prNumber = process.env.GITHUB_PR_NUMBER;
+  const token = process.env.GITHUB_TOKEN;
+
+  // Generate OAuth2 access token
+  const clientId = process.env.OAUTH2_CLIENT_ID;
+  const clientSecret = process.env.OAUTH2_CLIENT_SECRET;
+  const refreshToken = process.env.OAUTH2_REFRESH_TOKEN;
+
+  // validate params
+  if (!repo || !prNumber || !token || !clientId || !clientSecret || !refreshToken) {
+    console.error('Missing required environment variables.');
+    process.exit(1);
+  }
+
+  // the whole process is in a big try/catch. e.g. if the config file doesn't exist, github is down, etc.
+  try {
+    // Read and process the configuration file
+    const configFileContent = fs.readFileSync(configFilePath, 'utf-8');
+    const configRules = configFileContent
+      .split('\n')
+      .filter(line => line.trim() !== '' && !line.trim().startsWith('#')) // Ignore empty lines and comments
+      .map(line => {
+        const [regex, email] = line.split(':').map(part => part.trim());
+        return { regex: new RegExp(regex), email };
+      });
+
+    // Fetch changed files from github
+    const [owner, repoName] = repo.split('/');
+    const apiUrl = `https://api.github.com/repos/${owner}/${repoName}/pulls/${prNumber}/files`;
+    const response = await axios.get(apiUrl, {
+      headers: {
+        Authorization: `Bearer ${token}`,
+        Accept: 'application/vnd.github.v3+json',
+      },
+    });
+
+    const changedFiles = response.data.map(file => file.filename);
+    console.log('Changed files:', changedFiles);
+
+    // match file pathnames that are in the config and group them by email address
+    const matchesByEmail = {};
+    changedFiles.forEach(file => {
+      configRules.forEach(rule => {
+        if (rule.regex.test(file)) {
+          if (!matchesByEmail[rule.email]) {
+            matchesByEmail[rule.email] = [];
+          }
+          matchesByEmail[rule.email].push(file);
+        }
+      });
+    });
+
+    // Exit successfully if no matches were found
+    if (Object.keys(matchesByEmail).length === 0) {
+      console.log('No matches found. Exiting successfully.');
+      process.exit(0);
+    }
+
+    console.log('Grouped matches by email:', matchesByEmail);
+
+    // get ready to email the changes
+    const accessToken = await getAccessToken(clientId, clientSecret, refreshToken);
+
+    // Configure Nodemailer with OAuth2
+    //  service: 'Gmail',
+    const transporter = nodemailer.createTransport({
+      host: "smtp.gmail.com",
+      port: 465,
+      secure: true,
+      auth: {
+        type: 'OAuth2',
+        user: 'info@prebid.org',
+        clientId: clientId,
+        clientSecret: clientSecret,
+        refreshToken: refreshToken,
+        accessToken: accessToken
+      },
+    });
+
+    // Send one email per recipient
+    for (const [email, files] of Object.entries(matchesByEmail)) {
+      const emailBody = `
+        ${email},
+        <p>
+        Files owned by you have been changed in open source ${repo}. The <a href="https://github.com/${repo}/pull/${prNumber}">pull request is #${prNumber}</a>. These are the files you own that have been modified:
+        <ul>
+          ${files.map(file => `<li>${file}</li>`).join('')}
+        </ul>
+      `;
+
+      try {
+        await transporter.sendMail({
+          from: `"Prebid Info" <info@prebid.org>`,
+          to: email,
+          subject: `Files have been changed in open source ${repo}`,
+          html: emailBody,
+        });
+
+        console.log(`Email sent successfully to ${email}`);
+        console.log(`${emailBody}`);
+      } catch (error) {
+        console.error(`Failed to send email to ${email}:`, error.message);
+      }
+    }
+  } catch (error) {
+    console.error('Error:', error.message);
+    process.exit(1);
+  }
+})();

AGENTS.md

@@ -0,0 +1,7 @@
+# Agent Guidelines
+
+- Run `markdownlint` on any edited Markdown files using the repository configuration with `markdownlint --config .markdownlint.json README.md`. Replace `README.md` with each file you change.
+- If lint errors occur, fix them before creating a pull request.
+- Verify the site builds with `bundle exec jekyll build` when possible.
+- Please name your branch to include codex or agent in the branch name
+- If you cannot run markdownlint please warn your user to setup their environment using the instructions in README.md and document your failure in your pr description

Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 gem 'github-pages', '>= 228'
-
+gem 'ffi', '1.16.3'
 gem "webrick", "~> 1.7"

README.md

@@ -112,6 +112,26 @@ This means an adaptor is not available to download from Prebid.org as soon as th
 
 * [jekyll - check for non empty](https://michaelcurrin.github.io/dev-cheatsheets/cheatsheets/jekyll/liquid/conditionals/non-empty.html)
 
+## Codex
+
+To get started with Codex with Ruby 3.4.4 preinstalled on this repo, you can set up your environment like this
+
+```bash
+echo "3.4.4" > .ruby-version
+export NOKOGIRI_USE_SYSTEM_LIBRARIES=1
+gem install jekyll bundler
+npm install boostrap
+gem install github-pages --no-document --force
+npm install -g markdownlint-cli
+bundle install
+```
+
+Codex can then check for linting success with
+
+```bash
+markdownlint --config .markdownlint.json "**/*.md"
+```
+
 ## Thanks
 
 Many thanks to the following people who have submitted content to Prebid.org.  We really appreciate the help!