Skip to content

Commit 435f3cb

Browse files
committed
Update docs
1 parent 9f5f5c7 commit 435f3cb

2 files changed

Lines changed: 13 additions & 37 deletions

File tree

‎.github/workflows/codeql-analysis.yml‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ on:
44
push:
55
branches: [ 'main' ]
66
pull_request:
7-
# The branches below must be a subset of the branches above
87
branches: [ 'main' ]
98
schedule:
109
- cron: '33 9 * * 6'
@@ -15,29 +14,31 @@ jobs:
1514
name: Analyze
1615
runs-on: ubuntu-latest
1716
permissions:
18-
actions: read
19-
contents: read
2017
security-events: write
18+
strategy:
19+
fail-fast: false
20+
matrix:
21+
include:
22+
- language: actions
23+
build-mode: none
24+
- language: java-kotlin
25+
build-mode: none
2126

2227
steps:
2328
- name: Checkout repository
2429
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
2530

26-
# Only a bootstrap JVM for the Gradle launcher: the daemon and every toolchain
27-
# are provisioned by gradle-jdks (gradle/jdks/**), because gradle.properties
28-
# disables installation auto-detection.
29-
- name: Set up a bootstrap JDK
31+
- name: Set up JDK 21
3032
uses: actions/setup-java@de7274f081f381c8f8158605e0321c36c376e2e6 # v6.0.1
3133
with:
3234
distribution: temurin
3335
java-version: '21'
3436

35-
# Initializes the CodeQL tools for scanning.
36-
# Must run AFTER setup-java so CodeQL hooks into the correct JDK.
3737
- name: Initialize CodeQL
3838
uses: github/codeql-action/init@1c5b675653bb5c22dbe9b12b556ec555138e09fd # v4
3939
with:
40-
languages: 'java'
40+
languages: ${{ matrix.language }}
41+
build-mode: ${{ matrix.build-mode }}
4142

4243
- name: Build all source sets for CodeQL
4344
# --no-build-cache forces javac to run even if outputs are cached,
@@ -46,3 +47,5 @@ jobs:
4647

4748
- name: Perform CodeQL Analysis
4849
uses: github/codeql-action/analyze@1c5b675653bb5c22dbe9b12b556ec555138e09fd # v4
50+
with:
51+
category: "/language:${{matrix.language}}"

‎README.md‎

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -38,33 +38,6 @@ Each page is short and every command on it was run against the published artifac
3838
- [Eclipse](https://openjavaformat.dev/get-started/eclipse/)
3939
- [GitHub Action and pre-commit hook](https://openjavaformat.dev/get-started/github-actions/)
4040

41-
With Maven, add the plugin and name the open-java-format version it formats with. The plugin brings
42-
no formatter of its own, so the dependency is required:
43-
44-
```xml
45-
<plugin>
46-
<groupId>dev.openjavaformat</groupId>
47-
<artifactId>fmt-maven-plugin</artifactId>
48-
<version>2.27.0.1</version>
49-
<executions>
50-
<execution>
51-
<goals>
52-
<goal>format</goal>
53-
</goals>
54-
</execution>
55-
</executions>
56-
<dependencies>
57-
<dependency>
58-
<groupId>dev.openjavaformat</groupId>
59-
<artifactId>open-java-format</artifactId>
60-
<version>2.98.0.4</version>
61-
</dependency>
62-
</dependencies>
63-
</plugin>
64-
```
65-
66-
`format` rewrites the sources before they are compiled; the `check` goal fails the build instead.
67-
6841
## What the output looks like
6942

7043
Lines are up to 120 characters wide. A lambda stays on the line where it starts, and a long call

0 commit comments

Comments
 (0)