aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGoooler <wangzongler@gmail.com>2022-03-24 20:56:06 +0800
committerGitHub <noreply@github.com>2022-03-24 15:56:06 +0300
commitea4a3bf6c55da8b6cf1dde144d8d2ae854b80243 (patch)
tree28f35d41c6928d387ca6df78308263ce2d441a73
parentdd0fd03ea37554d79a02a8c6bcfd5f081dc6a1e1 (diff)
downloaddokka-ea4a3bf6c55da8b6cf1dde144d8d2ae854b80243.tar.gz
dokka-ea4a3bf6c55da8b6cf1dde144d8d2ae854b80243.tar.bz2
dokka-ea4a3bf6c55da8b6cf1dde144d8d2ae854b80243.zip
Optimize CI a bit (#2385)
* Bump actions/checkout to v3 * Bump actions/setup-java to v3 * Use gradle-build-action * Merge validation into check.yml * Reformat * Trim blank lines * Use https * Cleanup * Fix * Remove names * Cleanup * Rename validate to validate-wrapper * Use cirrus-actions/rebase@v1.5 * Use cirrus-actions/rebase@1.5
-rw-r--r--.github/workflows/apiCheck.yml14
-rw-r--r--.github/workflows/check.yml22
-rw-r--r--.github/workflows/dokka-examples.yml48
-rw-r--r--.github/workflows/gh-pages-examples.yml35
-rw-r--r--.github/workflows/gh-pages.yml13
-rw-r--r--.github/workflows/gradle-test.pr.yml18
-rw-r--r--.github/workflows/rebase.yml8
-rw-r--r--.github/workflows/s3-cleanup.yml1
-rw-r--r--.github/workflows/s3-snapshots.yml45
-rw-r--r--.github/workflows/wrapper-validation.yml10
10 files changed, 100 insertions, 114 deletions
diff --git a/.github/workflows/apiCheck.yml b/.github/workflows/apiCheck.yml
deleted file mode 100644
index 0e9c61d0..00000000
--- a/.github/workflows/apiCheck.yml
+++ /dev/null
@@ -1,14 +0,0 @@
-name: CI
-
-on: pull_request
-
-jobs:
- apiCheck:
- runs-on: ubuntu-latest
- steps:
- - uses: actions/checkout@v2
- - uses: actions/setup-java@v2
- with:
- distribution: 'zulu'
- java-version: 11
- - run: ./gradlew apiCheck --stacktrace
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
new file mode 100644
index 00000000..04b3cb72
--- /dev/null
+++ b/.github/workflows/check.yml
@@ -0,0 +1,22 @@
+name: Check
+
+on: pull_request
+
+jobs:
+ validate-wrapper:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - uses: gradle/wrapper-validation-action@v1
+
+ apiCheck:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - uses: actions/setup-java@v3
+ with:
+ distribution: 'zulu'
+ java-version: 11
+ - uses: gradle/gradle-build-action@v2
+ with:
+ arguments: apiCheck --stacktrace
diff --git a/.github/workflows/dokka-examples.yml b/.github/workflows/dokka-examples.yml
index bd15e404..f6b673b5 100644
--- a/.github/workflows/dokka-examples.yml
+++ b/.github/workflows/dokka-examples.yml
@@ -7,26 +7,27 @@ jobs:
strategy:
matrix:
projects: [
- examples/gradle/dokka-gradle-example,
- examples/gradle/dokka-kotlinAsJava-example,
- examples/gradle/dokka-library-publishing-example,
- examples/gradle/dokka-multimodule-example,
- examples/gradle/dokka-multiplatform-example,
- examples/gradle/dokka-customFormat-example
+ examples/gradle/dokka-gradle-example,
+ examples/gradle/dokka-kotlinAsJava-example,
+ examples/gradle/dokka-library-publishing-example,
+ examples/gradle/dokka-multimodule-example,
+ examples/gradle/dokka-multiplatform-example,
+ examples/gradle/dokka-customFormat-example
]
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
- uses: dorny/paths-filter@v2
id: filter
with:
filters: |
examples_changed:
- '${{ matrix.projects }}/**'
- - uses: actions/setup-java@v2
+ - uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 11
+ - uses: gradle/gradle-build-action@v2
- run: ./gradlew build --no-daemon --stacktrace
working-directory: ${{ matrix.projects }}
if: steps.filter.outputs.examples_changed == 'true'
@@ -35,25 +36,26 @@ jobs:
strategy:
matrix:
projects: [
- examples/gradle/dokka-gradle-example,
- examples/gradle/dokka-kotlinAsJava-example,
- examples/gradle/dokka-library-publishing-example,
- examples/gradle/dokka-multiplatform-example,
- examples/gradle/dokka-customFormat-example
+ examples/gradle/dokka-gradle-example,
+ examples/gradle/dokka-kotlinAsJava-example,
+ examples/gradle/dokka-library-publishing-example,
+ examples/gradle/dokka-multiplatform-example,
+ examples/gradle/dokka-customFormat-example
]
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
- uses: dorny/paths-filter@v2
id: filter
with:
filters: |
examples_changed:
- '${{ matrix.projects }}/**'
- - uses: actions/setup-java@v2
+ - uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 11
+ - uses: gradle/gradle-build-action@v2
- run: ./gradlew dokkaHtml --no-daemon --stacktrace
working-directory: ${{ matrix.projects }}
if: steps.filter.outputs.examples_changed == 'true'
@@ -61,20 +63,21 @@ jobs:
run-dokka-publishing:
strategy:
matrix:
- tasks: [dokkaJavadocJar, dokkaHtmlJar]
+ tasks: [ dokkaJavadocJar, dokkaHtmlJar ]
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
- uses: dorny/paths-filter@v2
id: filter
with:
filters: |
examples_changed:
- 'examples/gradle/dokka-library-publishing-example/**'
- - uses: actions/setup-java@v2
+ - uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 11
+ - uses: gradle/gradle-build-action@v2
- run: ./gradlew ${{ matrix.tasks }} --no-daemon --stacktrace
working-directory: examples/gradle/dokka-library-publishing-example
if: steps.filter.outputs.examples_changed == 'true'
@@ -89,17 +92,18 @@ jobs:
- task: "dokkaHtmlMultiModule"
dir: "examples/gradle/dokka-multimodule-example"
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
- uses: dorny/paths-filter@v2
id: filter
with:
filters: |
examples_changed:
- '${{ matrix.dir }}/**'
- - uses: actions/setup-java@v2
+ - uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 11
+ - uses: gradle/gradle-build-action@v2
- run: ./gradlew ${{ matrix.task }} --no-daemon --stacktrace
working-directory: ${{ matrix.dir }}
if: steps.filter.outputs.examples_changed == 'true'
@@ -107,7 +111,7 @@ jobs:
run-dokka-maven-example:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
- uses: dorny/paths-filter@v2
id: filter
with:
@@ -115,7 +119,7 @@ jobs:
examples_changed:
- 'examples/maven/**'
working-directory: examples/maven
- - uses: actions/setup-java@v2
+ - uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 11
diff --git a/.github/workflows/gh-pages-examples.yml b/.github/workflows/gh-pages-examples.yml
index a47d37b2..3edf2726 100644
--- a/.github/workflows/gh-pages-examples.yml
+++ b/.github/workflows/gh-pages-examples.yml
@@ -4,6 +4,7 @@ on:
push:
branches:
- master
+
jobs:
build-examples:
runs-on: ubuntu-latest
@@ -11,32 +12,29 @@ jobs:
strategy:
matrix:
projects: [
- dokka-gradle-example,
- dokka-kotlinAsJava-example,
- dokka-library-publishing-example,
- dokka-multiplatform-example,
- dokka-customFormat-example
+ dokka-gradle-example,
+ dokka-kotlinAsJava-example,
+ dokka-library-publishing-example,
+ dokka-multiplatform-example,
+ dokka-customFormat-example
]
steps:
- - name: Checkout dokka
- uses: actions/checkout@v2
+ - uses: actions/checkout@v3
- uses: dorny/paths-filter@v2
id: filter
with:
filters: |
examples_changed:
- 'examples/gradle/${{ matrix.projects }}/**'
-
- - uses: actions/setup-java@v2
+ - uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 11
-
+ - uses: gradle/gradle-build-action@v2
- name: Build html
run: ./gradlew dokkaHtml --no-daemon --stacktrace
working-directory: examples/gradle/${{ matrix.projects }}
if: steps.filter.outputs.examples_changed == 'true'
-
- name: Upload artifact
uses: actions/upload-artifact@v2
if: steps.filter.outputs.examples_changed == 'true'
@@ -49,29 +47,24 @@ jobs:
if: github.repository == 'Kotlin/dokka'
strategy:
matrix:
- projects: [
- dokka-versioning-multimodule-example
- ]
+ projects: [ dokka-versioning-multimodule-example ]
steps:
- - name: Checkout dokka
- uses: actions/checkout@v2
+ - uses: actions/checkout@v3
- uses: dorny/paths-filter@v2
id: filter
with:
filters: |
examples_changed:
- 'examples/gradle/${{ matrix.projects }}/**'
-
- - uses: actions/setup-java@v2
+ - uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 11
-
+ - uses: gradle/gradle-build-action@v2
- name: Build html
run: ./gradlew dokkaHtmlMultiModule --no-daemon --stacktrace
working-directory: examples/gradle/${{ matrix.projects }}
if: steps.filter.outputs.examples_changed == 'true'
-
- name: Upload artifact
uses: actions/upload-artifact@v2
if: steps.filter.outputs.examples_changed == 'true'
@@ -81,7 +74,7 @@ jobs:
deploy-examples:
runs-on: ubuntu-latest
- needs: [build-examples, build-multimodule-examples]
+ needs: [ build-examples, build-multimodule-examples ]
steps:
- uses: actions/download-artifact@v2
with:
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
index c444a3e4..40533252 100644
--- a/.github/workflows/gh-pages.yml
+++ b/.github/workflows/gh-pages.yml
@@ -5,18 +5,16 @@ on:
branches:
- master
release:
- types: [published]
+ types: [ published ]
jobs:
docs:
if: github.repository == 'Kotlin/dokka'
runs-on: ubuntu-latest
steps:
- - name: Checkout dokka
- uses: actions/checkout@v2
+ - uses: actions/checkout@v3
with:
path: dokka
-
- uses: dorny/paths-filter@v2
id: filter
with:
@@ -24,22 +22,19 @@ jobs:
docs_changed:
- 'docs/**'
working-directory: ./dokka
-
- - uses: actions/setup-java@v2
+ - uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 11
-
+ - uses: gradle/gradle-build-action@v2
- name: Get current dokka version
run: echo "DOKKA_VERSION=`./gradlew :properties | grep '^version:.*' | cut -d ' ' -f 2 | cut -d '-' -f 1`" >> $GITHUB_ENV
if: github.event_name == 'release' || steps.filter.outputs.docs_changed == 'true'
working-directory: ./dokka
-
- name: Build docs
run: ./gradlew mkdocsBuild -Pdokka_version=$DOKKA_VERSION --info
if: github.event_name == 'release' || steps.filter.outputs.docs_changed == 'true'
working-directory: ./dokka
-
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.event_name == 'release' || steps.filter.outputs.docs_changed == 'true'
diff --git a/.github/workflows/gradle-test.pr.yml b/.github/workflows/gradle-test.pr.yml
index 657e2494..f24bf477 100644
--- a/.github/workflows/gradle-test.pr.yml
+++ b/.github/workflows/gradle-test.pr.yml
@@ -1,4 +1,4 @@
-name: CI
+name: Test
on: pull_request
@@ -9,12 +9,14 @@ jobs:
version: [ 8, 11, 17 ]
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v2
- - uses: actions/setup-java@v2
+ - uses: actions/checkout@v3
+ - uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: ${{ matrix.version }}
- - run: ./gradlew clean test --stacktrace
+ - uses: gradle/gradle-build-action@v2
+ with:
+ arguments: clean test --stacktrace
test-windows:
strategy:
@@ -23,9 +25,11 @@ jobs:
fail-fast: false
runs-on: windows-latest
steps:
- - uses: actions/checkout@v2
- - uses: actions/setup-java@v2
+ - uses: actions/checkout@v3
+ - uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: ${{ matrix.version }}
- - run: ./gradlew clean test --stacktrace --no-daemon --parallel --max-workers=1
+ - uses: gradle/gradle-build-action@v2
+ with:
+ arguments: clean test --stacktrace --no-daemon --parallel --max-workers=1
diff --git a/.github/workflows/rebase.yml b/.github/workflows/rebase.yml
index 8cebe2a6..a64526e6 100644
--- a/.github/workflows/rebase.yml
+++ b/.github/workflows/rebase.yml
@@ -1,7 +1,9 @@
+name: Automatic Rebase
+
on:
issue_comment:
- types: [created]
-name: Automatic Rebase
+ types: [ created ]
+
jobs:
rebase:
name: Rebase
@@ -9,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout the latest code
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Automatic Rebase
diff --git a/.github/workflows/s3-cleanup.yml b/.github/workflows/s3-cleanup.yml
index 19876bf2..52372f2c 100644
--- a/.github/workflows/s3-cleanup.yml
+++ b/.github/workflows/s3-cleanup.yml
@@ -15,6 +15,5 @@ jobs:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: eu-central-1
-
- name: Delete branch from s3
run: aws s3 --recursive rm s3://${{ env.bucket-name }}/${{ github.event.ref }}
diff --git a/.github/workflows/s3-snapshots.yml b/.github/workflows/s3-snapshots.yml
index be7c3e8c..2e84050f 100644
--- a/.github/workflows/s3-snapshots.yml
+++ b/.github/workflows/s3-snapshots.yml
@@ -12,93 +12,84 @@ jobs:
if: github.repository == 'Kotlin/dokka'
steps:
- name: Checkout dokka
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
with:
submodules: true
-
- - uses: actions/setup-java@v2
+ - uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 12
-
- name: Document stdlib
- run: ./gradlew :integration-tests:gradle:integrationTest --tests org.jetbrains.dokka.it.gradle.kotlin.StdlibGradleIntegrationTest --stacktrace
+ uses: gradle/gradle-build-action@v2
+ with:
+ arguments: :integration-tests:gradle:integrationTest --tests org.jetbrains.dokka.it.gradle.kotlin.StdlibGradleIntegrationTest --stacktrace
env:
DOKKA_IT_AWS_PATH: /home/runner/work/dokka/stdlib
-
- name: Configure AWS credentials for S3 access
uses: aws-actions/configure-aws-credentials@v1
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: eu-central-1
-
- name: Copy files to dokka's S3 bucket
run: ./integration-tests/aws_sync.sh s3://${{ env.bucket-name }} stdlib ../stdlib
-
- name: Print link
- run: echo http://dokka-snapshots.s3.eu-central-1.amazonaws.com/${{ env.branch-name }}/stdlib/${GITHUB_SHA::7}/index.html
+ run: echo https://dokka-snapshots.s3.eu-central-1.amazonaws.com/${{ env.branch-name }}/stdlib/${GITHUB_SHA::7}/index.html
serialization:
runs-on: ubuntu-latest
if: github.repository == 'Kotlin/dokka'
steps:
- name: Checkout dokka
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
with:
submodules: true
-
- - uses: actions/setup-java@v2
+ - uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 12
-
- name: Document serialization
- run: ./gradlew :integration-tests:gradle:integrationTest --tests org.jetbrains.dokka.it.gradle.kotlin.SerializationGradleIntegrationTest --stacktrace
+ uses: gradle/gradle-build-action@v2
+ with:
+ arguments: :integration-tests:gradle:integrationTest --tests org.jetbrains.dokka.it.gradle.kotlin.SerializationGradleIntegrationTest --stacktrace
env:
DOKKA_IT_AWS_PATH: /home/runner/work/dokka/serialization
-
- name: Configure AWS credentials for S3 access
uses: aws-actions/configure-aws-credentials@v1
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: eu-central-1
-
- name: Copy files to dokka's S3 bucket
run: ./integration-tests/aws_sync.sh s3://${{ env.bucket-name }} serialization ../serialization
-
- name: Print link
- run: echo http://dokka-snapshots.s3.eu-central-1.amazonaws.com/${{ env.branch-name }}/serialization/${GITHUB_SHA::7}/index.html
+ run: echo https://dokka-snapshots.s3.eu-central-1.amazonaws.com/${{ env.branch-name }}/serialization/${GITHUB_SHA::7}/index.html
biojava:
runs-on: ubuntu-latest
if: github.repository == 'Kotlin/dokka'
steps:
- name: Checkout dokka
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
with:
submodules: true
-
- - uses: actions/setup-java@v2
+ - uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 12
-
- name: Document biojava-core
- run: ./gradlew :integration-tests:maven:integrationTest --tests org.jetbrains.dokka.it.maven.BiojavaIntegrationTest --stacktrace
+ uses: gradle/gradle-build-action@v2
+ with:
+ arguments: :integration-tests:maven:integrationTest --tests org.jetbrains.dokka.it.maven.BiojavaIntegrationTest --stacktrace
env:
DOKKA_IT_AWS_PATH: /home/runner/work/dokka/biojava
-
- name: Configure AWS credentials for S3 access
uses: aws-actions/configure-aws-credentials@v1
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: eu-central-1
-
- name: Copy files to dokka's S3 bucket
run: ./integration-tests/aws_sync.sh s3://${{ env.bucket-name }} biojava ../biojava
-
- name: Print link
- run: echo http://dokka-snapshots.s3.eu-central-1.amazonaws.com/${{ env.branch-name }}/biojava/${GITHUB_SHA::7}/index.html
+ run: echo https://dokka-snapshots.s3.eu-central-1.amazonaws.com/${{ env.branch-name }}/biojava/${GITHUB_SHA::7}/index.html
diff --git a/.github/workflows/wrapper-validation.yml b/.github/workflows/wrapper-validation.yml
deleted file mode 100644
index 7c78fcf1..00000000
--- a/.github/workflows/wrapper-validation.yml
+++ /dev/null
@@ -1,10 +0,0 @@
-name: "Validate Gradle Wrapper"
-on: pull_request
-
-jobs:
- validation:
- name: "Validation"
- runs-on: ubuntu-latest
- steps:
- - uses: actions/checkout@v2
- - uses: gradle/wrapper-validation-action@v1.0.4 \ No newline at end of file