Relevant source files

The following files were used as context for generating this wiki page: - [src/main.ts](https://github.com/Trancendos/dependabot-changesets/blob/main/src/main.ts) - [src/utils.ts](https://github.com/Trancendos/dependabot-changesets/blob/main/src/utils.ts) - [action.yml](https://github.com/Trancendos/dependabot-changesets/blob/main/action.yml) - [README.md](https://github.com/Trancendos/dependabot-changesets/blob/main/README.md) - [CHANGELOG.md](https://github.com/Trancendos/dependabot-changesets/blob/main/CHANGELOG.md) - [package.json](https://github.com/Trancendos/dependabot-changesets/blob/main/package.json)

# Troubleshooting & Debugging Action Runs This guide provides technical insights into troubleshooting the Dependabot Changesets GitHub Action. The action is designed to automate the creation and commitment of changeset files for dependency updates initiated by Dependabot. Understanding the internal logic of PR parsing, Git operations, and API interactions is essential for diagnosing failures during workflow execution. The action operates by intercepting Pull Requests (PRs), identifying the specific package updates described in the PR metadata, and generating corresponding Markdown files in the `.changeset/` directory. If these steps fail, the workflow may exit with errors or skip necessary updates. Sources: [README.md:1-5](), [src/main.ts:25-30]() ## Input Validation and Configuration Debugging often begins with verifying the inputs provided in the workflow YAML. The action requires specific GitHub context to interact with the repository and the PR. | Input Name | Required | Default | Description | | :--- | :--- | :--- | :--- | | `owner` | Yes | N/A | Repository owner. | | `repo` | Yes | N/A | Repository name. | | `pr-number` | Yes | N/A | The PR being processed. | | `token` | Yes | N/A | GitHub API token. | | `update-type` | No | `patch` | Changeset semver type. | | `git-user` | No | `dependabot[bot]` | Committer name for Git. | Sources: [action.yml:11-42](), [src/main.ts:31-40]() ## PR Analysis and Parsing Logic A common point of failure is the action's inability to detect updates within a PR. The system distinguishes between "grouped" and "ungrouped" PRs based on the title and body. ### Grouped PR Identification The action uses a specific regex `/[Bb]ump the .+? group/` to determine if a PR contains multiple dependency updates. If this check fails, the action may only attempt to parse a single update from the title instead of scanning the body for multiple entries. Sources: [src/utils.ts:1-4](), [src/main.ts:50-52]() ### Extraction Flow When a PR is identified as grouped, the action scans the `pr.data.body`. If the body is too long (truncated by GitHub) or empty, the action falls back to searching the commit messages for update strings. ```mermaid flowchart TD Start[Analyze PR Title] --> CheckGroup{Is Grouped?} CheckGroup -- Yes --> ParseBody[Parse PR Body] ParseBody --> FoundUpdates{Updates Found?} FoundUpdates -- No --> ListCommits[Fetch PR Commits] ListCommits --> ParseCommits[Parse Commit Message] FoundUpdates -- Yes --> ProcessUpdates[Process PackageUpdate List] ParseCommits --> ProcessUpdates CheckGroup -- No --> ParseTitle[Extract from Title] ParseTitle --> ProcessUpdates ``` Sources: [src/main.ts:50-71](), [src/utils.ts:7-21]() ## Git and Filesystem Operations Failures during the "commit and push" phase usually relate to Git configuration or permissions. The action performs the following sequence: 1. **File Generation**: Creates `.changeset/.md`. 2. **Deduplication**: Reads existing changesets to avoid duplicate entries for the same version update. 3. **Git Config**: Sets the global `user.name` and `user.email` using the provided inputs. 4. **Persistence**: Executes `git add`, `git commit`, and `git push`. ### Debugging Git Errors If the `git push` fails, ensure the `token` provided has `contents: write` permissions. The action uses `exec` to run standard Git commands. ```typescript await exec('git', ['config', '--global', 'user.name', gitUser]); await exec('git', ['config', '--global', 'user.email', gitEmail]); await exec('git add .changeset/*'); await exec('git', ['commit', '-m', commitMessage]); await exec('git push'); ``` Sources: [src/main.ts:101-105](), [package.json:69-71]() ## Common Error Scenarios ### 1. "Error fetching PR" This error occurs if the Octokit client receives a non-200 status code from the GitHub API. It usually indicates an invalid `token`, incorrect `owner`/`repo` inputs, or a `pr-number` that does not exist. Sources: [src/main.ts:44-48]() ### 2. "No dependency updates found in PR" This is a graceful exit rather than a failure. It happens when neither the PR title nor the body matches the expected update patterns. * **Expected Title Pattern**: `Bump from to ` * **Expected Body Pattern**: `Updates from to ` Sources: [src/main.ts:74-77](), [src/utils.ts:28-44]() ### 3. Changeset Already Present The action includes logic to "dedupe" updates. If a changeset for the package already exists, the action updates the "from" version in the new changeset to match the original starting point, ensuring the changelog remains coherent across multiple Dependabot rebases. Sources: [src/main.ts:81-91](), [CHANGELOG.md:14-15]() ## Execution Summary The action's reliability depends on its ability to accurately parse the string patterns generated by Dependabot. When debugging, users should compare the PR text against the regex patterns defined in `src/utils.ts`. ```mermaid sequenceDiagram participant GH as GitHub API participant AC as Action Runner participant FS as Filesystem/Git AC->>GH: Get PR Details GH-->>AC: PR Title & Body AC->>AC: extractUpdates() alt updates > 0 AC->>FS: readFile (check existing) AC->>FS: writeFile (new changeset) AC->>FS: git push else updates == 0 AC->>AC: core.info("no updates found") end ``` Sources: [src/main.ts:43-108](), [src/utils.ts:50-65]()