Add GitHub actions

Author: gabrielfeo

.github/actions/build/action.yml

@@ -0,0 +1,35 @@
+name: 'Build'
+description: 'Run a Gradle build'
+inputs:
+  tasks:
+    description: "Gradle tasks"
+    required: true
+  artifact-name:
+    description: "Artifact name"
+    required: false
+  path-to-upload:
+    description: "Path to upload as artifact"
+    required: false
+runs:
+  using: "composite"
+  steps:
+    - name: Set up Java
+      uses: actions/setup-java@v2
+      with:
+        distribution: temurin
+        java-version: 8
+    - name: Set up Gradle env
+      uses: gradle/gradle-build-action@v2.1.4
+    - name: Run Gradle tasks
+      shell: bash
+      run: |
+        echo "::group::Gradle build log"
+        ./gradlew ${{ inputs.tasks }}
+        echo "::endgroup::"
+    - name: Upload
+      if: ${{ inputs.path-to-upload }}
+      uses: actions/upload-artifact@v3.0.0
+      with:
+        name: ${{ inputs.artifact-name }}
+        path: ${{ inputs.path-to-upload }}
+        if-no-files-found: error

.github/scripts/read_current_api_spec_version.py

@@ -0,0 +1,19 @@
+#!/usr/bin/env python3
+
+
+def get_current_api_spec_version(properties_file) -> str:
+    with open(properties_file, mode='r') as file:
+        for line in file.readlines():
+            if '=' not in line:
+                continue
+            k, v = line.strip().split('=', maxsplit=2)
+            if k == 'gradle.enterprise.version':
+                return v
+
+
+def main(properties_file):
+    print(get_current_api_spec_version(properties_file))
+
+
+if __name__ == '__main__':
+    main(properties_file='gradle.properties')

.github/scripts/test_read_current_api_spec_version.py

@@ -0,0 +1,26 @@
+#!/usr/bin/env python3
+
+from read_current_api_spec_version import main
+from tempfile import NamedTemporaryFile
+import unittest
+from unittest import mock
+
+
+class TestReadCurrentApiSpecVersion(unittest.TestCase):
+
+    def setUp(self):
+        self.properties_file = NamedTemporaryFile()
+        self.properties_file.write(b'gradle.enterprise.version=2022.4\n1=2\n')
+        self.properties_file.flush()
+
+    def tearDown(self):
+        self.properties_file.close()
+
+    @mock.patch('builtins.print')
+    def test_main(self, mock_print):
+        main(self.properties_file.name)
+        mock_print.assert_called_once_with('2022.4')
+
+
+if __name__ == '__main__':
+    unittest.main()

.github/scripts/test_update_api_spec_version.py

@@ -0,0 +1,52 @@
+#!/usr/bin/env python3
+
+from update_api_spec_version import main
+from tempfile import NamedTemporaryFile
+import unittest
+from unittest import mock
+
+
+class TestCheckForNewApiSpec(unittest.TestCase):
+
+    def setUp(self):
+        self.properties_file = NamedTemporaryFile()
+        self.properties_file.write(b'gradle.enterprise.version=2022.4\n1=2\n')
+        self.properties_file.flush()
+
+    def tearDown(self):
+        self.properties_file.close()
+
+    @mock.patch('builtins.print')
+    @mock.patch('requests.get')
+    def test_main_many_updates_available(self, mock_get, mock_print):
+        mock_get.return_value.status_code = 200
+
+        main(self.properties_file.name)
+
+        with open(self.properties_file.name) as file:
+            self.assertEqual(file.read(),
+                             'gradle.enterprise.version=2023.4\n1=2\n')
+        mock_get.assert_called_once_with(
+            'https://docs.gradle.com/enterprise/api-manual/ref/gradle-enterprise-2023.4-api.yaml'
+        )
+
+    @mock.patch('builtins.print')
+    @mock.patch('requests.get')
+    def test_main_no_updates_available(self, mock_get, mock_print):
+        mock_get.return_value.status_code = 404
+
+        main(self.properties_file.name)
+
+        with open(self.properties_file.name) as file:
+            self.assertEqual(file.read(),
+                             'gradle.enterprise.version=2022.4\n1=2\n')
+        mock_get.assert_has_calls([
+            mock.call(
+                'https://docs.gradle.com/enterprise/api-manual/ref/gradle-enterprise-2023.4-api.yaml'),
+            mock.call(
+                'https://docs.gradle.com/enterprise/api-manual/ref/gradle-enterprise-2022.5-api.yaml'),
+        ])
+
+
+if __name__ == '__main__':
+    unittest.main()

.github/scripts/update_api_spec_version.py

@@ -0,0 +1,49 @@
+#!/usr/bin/env python3
+
+import requests
+import fileinput
+import sys
+from read_current_api_spec_version import get_current_api_spec_version
+
+
+def get_possible_version_bumps(version: str) -> list[str]:
+    parts: list = version.split('.')
+    possible_bumps = []
+    for i in range(len(parts)):
+        bump = parts.copy()
+        bumped_part = int(bump[i]) + 1
+        bump[i] = str(bumped_part)
+        possible_bumps.append(".".join(bump))
+    return possible_bumps
+
+
+def get_first_available_version(versions: list[str]) -> str:
+    for version in versions:
+        response = requests.get(
+            f"https://docs.gradle.com/enterprise/api-manual/ref/gradle-enterprise-{version}-api.yaml")
+        if response.status_code == 200:
+            return version
+
+
+def update_version(properties_file, new_version):
+    for line in fileinput.input(properties_file, inplace=True):
+        if '=' in line:
+            k, v = line.strip().split('=', maxsplit=2)
+            if k == 'gradle.enterprise.version':
+                line = f"{k}={new_version}\n"
+        sys.stdout.write(line)
+
+
+def main(properties_file):
+    current = get_current_api_spec_version(properties_file)
+    possible_bumps = get_possible_version_bumps(current)
+    available_update = get_first_available_version(possible_bumps)
+    if available_update:
+        print(f"Updating to {available_update}")
+        update_version(properties_file, available_update)
+    else:
+        print('No update available')
+
+
+if __name__ == '__main__':
+    main(properties_file='gradle.properties')

.github/workflows/check-new-api-spec.yml

@@ -0,0 +1,34 @@
+name: 'Check for new API spec version'
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 6 * * 1'
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+
+  check-new-api-spec:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout'
+        uses: actions/checkout@v3
+      - name: 'Update API spec version'
+        run: ./.github/scripts/update_api_spec_version.py
+      - name: 'Read current spec version'
+        run: |
+          version="$(./.github/scripts/read_current_api_spec_version.py)"
+          [[ -n "$version" ]]
+          echo "SPEC_VERSION=$version" | tee -a "$GITHUB_ENV"
+      - name: 'Create PR'
+        uses: peter-evans/create-pull-request@v4
+        with:
+          branch: "feature/api-spec-${{ env.SPEC_VERSION }}"
+          commit-message: "Bump GE API spec version to ${{ env.SPEC_VERSION }}"
+          title: "Support Gradle Enterprise API ${{ env.SPEC_VERSION }}"
+          body: "https://docs.gradle.com/enterprise/api-manual/#release_history"
+          author: "github-actions <github-actions@github.com>"
+          committer: "github-actions <github-actions@github.com>"

.github/workflows/pr.yml

@@ -0,0 +1,46 @@
+name: 'Check PR'
+
+on:
+  pull_request
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+
+  kotlin-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Check for modified code
+        id: diff
+        uses: tj-actions/changed-files@v24
+        with:
+          files: |
+            **/src/**
+            **/*.gradle*
+            ./gradle/*
+      - name: gradle check
+        if: ${{ steps.diff.outputs.all_modified_files }}
+        uses: ./.github/actions/build
+        with:
+          tasks: 'check'
+          # artifact-name: 'Test reports (${{matrix.runner}})'
+          # path-to-upload: '**/build/reports/tests/**'
+
+  python-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Check for modified code
+        id: diff
+        uses: tj-actions/changed-files@v24
+        with:
+          files: |
+            **/*.py
+      - name: 'unittest discover'
+        if: ${{ steps.diff.outputs.all_modified_files }}
+        run: python3 -m unittest discover -bs .github/scripts

.github/workflows/publish-javadoc.yml

@@ -0,0 +1,56 @@
+name: 'Publish javadoc'
+
+on:
+  push:
+    tags: ['*']
+  workflow_dispatch:
+    inputs:
+      version_name:
+        description: 'Version'
+        required: true
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  VERSION_NAME: ${{ github.event.inputs.version_name || github.ref_name }}
+
+jobs:
+
+  build-javadoc:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ env.VERSION }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ env.VERSION_NAME }}
+      - name: Build javadoc
+        uses: ./.github/actions/build
+        with:
+          tasks: 'javadocJar'
+          artifact-name: 'javadoc'
+          path-to-upload: "build/libs/gradle-enterprise-api-kotlin-${{ env.VERSION_NAME }}-javadoc.jar"
+
+  commit-to-gh-pages:
+    needs: [build-javadoc]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ env.VERSION_NAME }}
+      - name: Download javadoc
+        uses: actions/download-artifact@v3
+      - name: Commit and push
+        run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+          git checkout gh-pages
+          rm -rf docs
+          unzip "gradle-enterprise-api-kotlin-$VERSION_NAME-javadoc.jar" -d docs
+          git add docs
+          git commit -m "Add $VERSION_NAME javadoc"
+          git push

.gitignore

@@ -3,12 +3,14 @@ out
 !*/src/**/out
 
 build
+!.github/actions/build
 !*/src/**/build
 !*/*/src/**/build
 
-local.properties
+__pycache__
 
 **/.log
 .DS_Store
 
-.idea
+.idea
+local.properties