required: false
        default: ''

jobs:
  gitStream:
    timeout-minutes: 15
    runs-on: ubuntu-latest
    name: gitStream workflow automation
    steps:
      - name: Evaluate Rules
        uses: linear-b/gitstream-github-action@v1
        env:
          REPO_READ_TOKEN: ${{ secrets.GITSTREAM_TESTING_TOKEN }}
        id: rules-engine
        with:

 * </ul>
 *
 * or
 *
 * <ul>
 *     <li>Someone has commented `@bot-gitstream run <NAME_OF_AUTOMATION>` (the file name, without the `.cm` suffix) on the PR.</li>
 * </ul>
 *
 * @param {string} automationName - The automation name (*.cm file name containing the automation) to check.
 * @param {Map} pr - The gitStream PR instance to check (includes metadata related to the pull request).

/**
 * @module byCodeowner
 * @description Groups the PR's files' by owner based on the CODEOWNERs file.
 * @param {string[]} files - the gitStream's files context variable
 * @param {Object} pr - the gitStream's pr context variable
 * @param {string} token - access token with repo:read scope, used to read the CODEOWNERS file
 * @param {string} pathToCodeOwners - path from repo root to CODEOWNERS file
 * @returns {Map} - Map from owner name to list of files they own

  # Total number of files changed
  total: {{ branch.diff.files_metadata | length }}

is:
  requested: {{ (pr.comments | match(attr='content', term='@bot-gitstream check all') | some) or (pr.comments | match(attr='content', term='@bot-gitstream check summary') | some) }}

author:
  using_gitstream: {{ (pr.author | isEnabledUser ) }}

 * @param {Map} fileOwners mapping of platform name to a list of files involved in the change located in that platform
 * @param {[FileMetadata]} fileMetadatas - gitStream's list of metadata about file changes in the PR including path
 * @returns {[Object]} Returns a list of objects for each platform containing info about the changes to files in that platform

const jvm = ["big-guy", "ghale", "jvandort", "octylFractal", "tresat"];

/**
 * @module isEnabledUser
 * @description Returns true if the username that is passed to this function is a member of the Gradle BT Team who has opted into gitStream automations.
 * @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.

/**
 * @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)) {

 *
 * @param {Map} groupedFiles - map of platforms for containing info about the changes to files in that platform, from call to categorize
 * @param {[FileMetadata]} fileMetadatas - gitStream's list of metadata about file changes in the PR including path
 * @returns {[Object]} Returns list of computed summary statistic objects for each platform in the input groupedFiles

is_docs_only_change: {{ (files | allDocs) or (files | match(regex=r/\.adoc$/) | every) }} # This won't catch a mix of .adoc and non .adoc changes, see: https://github.com/linear-b/gitstream/issues/93

# Extensibility
platforms/extensibility/        @gradle/bt-extensibility-maintainers

# Native
platforms/native/                   @gradle/bt-native-maintainers

# gitStream files
.cm/                                @tresat
.github/workflows/gitstream.yml     @tresat

# IDE Experience team
platforms/ide/                    @gradle/bt-ide-experience
# Eventually be moved to the core platform.