# within the file.  We keep each automation (or very closely related group of automations) in
# its own file.

on:
  - pr_created
  - commit
  - comment_added

automations:

  summary_table_platforms:
    if:
      - {{ ('summary_table_platforms' | isEnabledAutomation(pr)) }}
    run:
      - action: add-comment@v1
        args:
          comment: |
            {{ by_platform_comment }}

# its own file.

on:
  - pr_created
  - commit
  - comment_added

automations:

  # If someone adds a TODO, remind them about it by requesting removal
  includes_todos:
    if:
      - {{ ('includes_todos' | isEnabledAutomation(pr)) }}
      - {{ source.diff.files | matchDiffLines(regex=r/(TODO)|(todo)/) | some }}
    run:

# its own file.

on:
  - pr_created
  - commit
  - comment_added

automations:

  javadoc_on_new_files:
    # Triggered for new Java files that lack Javadoc content.
    if:

      - {{ ('javadoc_on_new_files' | isEnabledAutomation(pr)) }}
      - {{ is.java and is.new }}

  workflow_dispatch:

permissions: {}

jobs:
  feedback:
    permissions:
      issues: write
      pull-requests: write
    runs-on: ubuntu-latest
    steps:
      # Feedback loop: ask for something on PR/Issue and close if not provided or return to the queue on update.
      # https://github.com/gradle/issue-management-action/blob/main/src/feedback.ts
      - uses: gradle/issue-management-action@v1
        with:

# its own file.

on:
  - pr_created
  - commit
  - comment_added

automations:

  # Also post a comment that lists the best experts for the files that were modified.
  comment_experts:
    if:
      - {{ ('code_experts' | isEnabledAutomation(pr)) }}
    run:
      - action: explain-code-experts@v1
        args:

/**
 * @module byPlatform
 * @description Groups the PR's files by platform based on the file's path.
 * @param {string[]} files - the gitStream's files context variable
 * @returns {Map} - Map from platform to list of files in this PR in it
 * @example {{ owners | byPlatform }}
 */
function byPlatform(files) {
    const result = new Map();
    files.forEach(file => {
        const platform = getPlatform(file);
        if (!result.has(platform)) {

/**
 * The logical branch.
 * For non-merge-queue branches this is the same as {@link #buildBranch}.
 * For merge-queue branches, this is the base branch.
 *
 * For example, for the merge queue branch "gh-readonly-queue/master/pr-12345-1a2b3c4d" the logical branch is "master".
 */
val Project.logicalBranch: Provider<String>
    get() = buildBranch.map(::toMergeQueueBaseBranch)


val Project.buildCommitId: Provider<String>

 * @param {string} Input - The GitHub username to check.
 * @returns {boolean} Returns true if the user is specified in any of the lists of Gradle BT team members above, otherwise false.
 * @example {{ pr.author | isEnabledUser }}
 */
function isEnabledUser(username) {

# Code generated by gitStream GitHub app - DO NOT EDIT

name: gitStream workflow automation
run-name: |
  /:\ gitStream: PR #${{ fromJSON(fromJSON(github.event.inputs.client_payload)).pullRequestNumber }} from ${{ github.event.inputs.full_repository }}

on:
  workflow_dispatch:
    inputs:
      client_payload:
        description: The Client payload
        required: true
      full_repository:

* They are not synced with the code to reflect the eventual solution that is committed
* Google Docs is not a "code-oriented" tool, like asciidoc can be
* Review in Google Docs is not as simple as a PR code review in GitHub

## Decision

The *Build Tool Team* has decided to use Architectural Decision Records (aka ADR) to track decisions we want to follow.