Skip to content

ci: add Makefile and GitHub Actions workflow for PR checks #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wombatu-kun wants to merge 3 commits into
base: main
Choose a base branch
from
Open

ci: add Makefile and GitHub Actions workflow for PR checks #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fd50c7c
build: add spotless, checkstyle, and enforcer plugin configuration
Apr 22, 2026
df2272c
chore: apply initial spotless formatting
Apr 22, 2026
46ca1fa
ci: add Makefile and GitHub Actions workflow for PR checks
Apr 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.java]
indent_style = space
indent_size = 2
max_line_length = 100

[*.{xml,yml,yaml}]
indent_style = space
indent_size = 2

[Makefile]
indent_style = tab
48 changes: 48 additions & 0 deletions .github/workflows/flink.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Flink CI

on:
push:
branches: [main]
paths-ignore:
- '**.md'
- 'docs/**'
pull_request:
types: [opened, synchronize, ready_for_review, reopened]
paths-ignore:
- '**.md'
- 'docs/**'

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}

jobs:
lint:
runs-on: ubuntu-24.04
timeout-minutes: 10
steps:
- uses: actions/checkout@v4
- name: Set up JDK
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: '8'
cache: maven
- name: Run lint
run: make lint

build-and-test:
runs-on: ubuntu-24.04
timeout-minutes: 30
steps:
- uses: actions/checkout@v4
- name: Set up JDK
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: '8'
cache: maven
- name: Install
run: make install
- name: Test
run: make test
44 changes: 44 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
SHELL := /bin/bash
MAVEN := mvn

.PHONY: install test build bundle clean lint format \
install-all test-all build-all help

help:
@echo "Available targets:"
@echo " install Install artifact to local .m2 (skip tests)"
@echo " test Run unit and integration tests"
@echo " build Run lint + install"
@echo " bundle Build shaded fat-jar (skip tests)"
@echo " clean Remove target/"
@echo " lint Run Spotless and Checkstyle checks"
@echo " format Apply Spotless formatting in place"
@echo " install-all Alias of install (reserved for future multi-module matrix)"
@echo " test-all Alias of test (reserved for future multi-module matrix)"
@echo " build-all Alias of build (reserved for future multi-module matrix)"

install:
$(MAVEN) install -DskipTests

test:
$(MAVEN) test

build:
$(MAKE) lint
$(MAKE) install

bundle:
$(MAVEN) package -DskipTests

clean:
$(MAVEN) clean

lint:
$(MAVEN) spotless:check checkstyle:check

format:
$(MAVEN) spotless:apply

install-all: install
test-all: test
build-all: build
174 changes: 174 additions & 0 deletions checkstyle.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
<!--
~ Licensed to the Apache Software Foundation (ASF) under one or more
~ contributor license agreements. See the NOTICE file distributed with
~ this work for additional information regarding copyright ownership.
~ The ASF licenses this file to You under the Apache License, Version 2.0
~ (the "License"); you may not use this file except in compliance with
~ the License. You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->

<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">

<module name = "Checker">
<property name="charset" value="UTF-8"/>

<property name="severity" value="error"/>

<property name="fileExtensions" value="java, properties, xml"/>

<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
<module name="FileTabCharacter">
<property name="eachLine" value="true"/>
</module>

<module name="RegexpSingleline">
<!-- \s matches whitespace character, $ matches end of line. -->
<property name="format" value="\s+$"/>
<property name="message" value="No trailing whitespace allowed."/>
</module>

<module name="LineLength">
<property name="max" value="100"/>
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
</module>

<module name="TreeWalker">
<!--
If you wish to turn off checking for a section of code, you can put a comment in the source
before and after the section, with the following syntax:

// checkstyle.off: XXX (such as checkstyle.off: NoFinalizer)
... // stuff that breaks the styles
// checkstyle.on: XXX (such as checkstyle.on: NoFinalizer)
-->
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="checkstyle\.off\: ([\w\|]+)"/>
<property name="onCommentFormat" value="checkstyle\.on\: ([\w\|]+)"/>
<property name="checkFormat" value="$1"/>
</module>
<module name="OuterTypeFilename"/>
<module name="IllegalTokenText">
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
<property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
<property name="message" value="Avoid using corresponding octal or Unicode escape."/>
</module>
<module name="AvoidEscapedUnicodeCharacters">
<property name="allowEscapesForControlCharacters" value="true"/>
<property name="allowByTailComment" value="true"/>
<property name="allowNonPrintableEscapes" value="true"/>
</module>
<module name="NoLineWrap"/>
<module name="EmptyBlock">
<property name="option" value="TEXT"/>
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
</module>
<module name="NeedBraces">
<property name="allowSingleLineStatement" value="true"/>
</module>
<module name="OneStatementPerLine"/>
<module name="ArrayTypeStyle"/>
<module name="FallThrough"/>
<module name="UpperEll"/>
<module name="ModifierOrder"/>
<module name="SeparatorWrap">
<property name="tokens" value="DOT"/>
<property name="option" value="nl"/>
</module>
<module name="SeparatorWrap">
<property name="tokens" value="COMMA"/>
<property name="option" value="EOL"/>
</module>
<module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
<message key="name.invalidPattern"
value="Package name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="ClassTypeParameterName">
<property name="format" value="([A-Z][a-zA-Z0-9]*$)"/>
<message key="name.invalidPattern"
value="Class type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="MethodTypeParameterName">
<property name="format" value="([A-Z][a-zA-Z0-9]*)"/>
<message key="name.invalidPattern"
value="Method type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="GenericWhitespace">
<message key="ws.followed"
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
<message key="ws.preceded"
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
<message key="ws.illegalFollow"
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
<message key="ws.notPreceded"
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
</module>
<module name="MethodParamPad"/>
<module name="AnnotationLocation">
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
</module>
<module name="AnnotationLocation">
<property name="tokens" value="VARIABLE_DEF"/>
<property name="allowSamelineMultipleAnnotations" value="true"/>
</module>
<module name="MethodName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
<message key="name.invalidPattern"
value="Method name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="EmptyCatchBlock">
<property name="exceptionVariableName" value="expected"/>
</module>
<module name="CommentsIndentation"/>
<module name="UnusedImports"/>
<module name="RedundantImport"/>
<module name="RedundantModifier"/>
<module name="RegexpSinglelineJava">
<property name="format" value="throw new \w+Error\("/>
<property name="message" value="Avoid throwing error in application code."/>
</module>
<module name="RegexpSinglelineJava">
<property name="format" value="Objects\.toStringHelper"/>
<property name="message" value="Avoid using Object.toStringHelper. Use ToStringBuilder instead." />
</module>
<module name="RegexpSinglelineJava">
<property name="format" value="new (java\.lang\.)?(Byte|Integer|Long|Short)\("/>
<property name="message" value="Use static factory 'valueOf' or 'parseXXX' instead of the deprecated constructors." />
</module>
<module name="RegexpSinglelineJava">
<property name="format" value="Files\.createTempDir\("/>
<property name="message"
value="Avoid using com.google.common.io.Files.createTempDir() due to CVE-2020-8908. Use java.nio.file.Files.createTempDirectory() instead." />
</module>
<module name="RegexpSinglelineJava">
<property name="format" value="FileBackedOutputStream"/>
<property name="message" value="Avoid using FileBackedOutputStream due to CVE-2023-2976." />
</module>
<module name="RegexpSinglelineJava">
<property name="format" value="AtomicDoubleArray"/>
<property name="message" value="Avoid using AtomicDoubleArray due to CVE-2018-10237." />
</module>
<module name="RegexpSinglelineJava">
<property name="format" value="CompoundOrdering"/>
<property name="message" value="Avoid using CompoundOrdering due to CVE-2018-10237." />
</module>
<module name="RegexpSinglelineJava">
<property name="format" value="@Test\(expected"/>
<property name="message" value="Please use the `assertThrows` method to test for exceptions." />
</module>
<module name="IllegalImport">
<property name="illegalPkgs" value="org.apache.log4j,org.apache.commons.lang" />
</module>
</module>
</module>
Loading