Skip to content

Commit c0a6efa

Browse files
CI: exclude generated code from format check
dart format has changed its format and determines this by looking at the resolved required SDK of a package. Because the objectbox_test package where code is generated does not yet require a recent Dart SDK, dart format will fail, because the generator formats using the latest style.
1 parent dfd5b52 commit c0a6efa

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

.github/workflows/code-analysis.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ env:
1919
DART_VERSION: 3.7.2 # Available versions: https://dart.dev/get-dart/archive
2020

2121
jobs:
22-
analyze-and-format:
22+
format-and-analyze:
2323
runs-on: ubuntu-24.04
2424
steps:
2525
- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
@@ -33,6 +33,13 @@ jobs:
3333
dart pub get --directory=generator
3434
dart pub get --directory=objectbox
3535
dart pub get --directory=objectbox_test
36+
flutter pub get --directory=flutter_libs
37+
flutter pub get --directory=sync_flutter_libs
38+
# Since Dart 3.7, dart format needs pub get to run before formatting,
39+
# so to check formatting of Flutter packages run pub get for them as well.
40+
# Also run before generating code to exclude generated code.
41+
- name: Check formatting of all packages
42+
run: dart format --set-exit-if-changed .
3643
- name: Generate code (benchmark)
3744
working-directory: benchmark
3845
run: dart run build_runner build
@@ -45,13 +52,6 @@ jobs:
4552
dart analyze generator
4653
dart analyze objectbox
4754
dart analyze objectbox_test
48-
- name: Check formatting of all packages
49-
# Since Dart 3.7, dart format needs pub get to run before formatting,
50-
# so to check formatting of Flutter packages run pub get for them first.
51-
run: |
52-
flutter pub get --directory=flutter_libs
53-
flutter pub get --directory=sync_flutter_libs
54-
dart format --set-exit-if-changed .
5555
5656
pana:
5757
runs-on: ubuntu-24.04

.gitlab-ci.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ variables:
3232
key: "linux-x64-dart-$DART_VERSION-pub-cache"
3333

3434
# Analyze (only) Dart packages, check formatting in Dart and Flutter packages.
35-
analyze-and-format:
35+
format-and-analyze:
3636
extends: .cache
3737
stage: code-analysis
3838
script:
@@ -42,6 +42,14 @@ analyze-and-format:
4242
- dart pub get --directory=objectbox
4343
- dart pub get --directory=objectbox_test
4444
- dart pub get --directory=objectbox/example/dart-native/vectorsearch_cities
45+
# Since Dart 3.7, dart format needs pub get to run before formatting,
46+
# so can no longer check formatting of Flutter packages (would require Flutter SDK):
47+
# Check formatting only for Dart packages (run before generating code to exclude generated code)
48+
- dart format --set-exit-if-changed benchmark
49+
- dart format --set-exit-if-changed generator
50+
- dart format --set-exit-if-changed objectbox
51+
- dart format --set-exit-if-changed objectbox_test
52+
- dart format --set-exit-if-changed objectbox/example/dart-native
4553
# Generate code
4654
- cd benchmark
4755
- dart run build_runner build
@@ -56,14 +64,6 @@ analyze-and-format:
5664
- dart analyze objectbox
5765
- dart analyze objectbox_test
5866
- dart analyze objectbox/example/dart-native/vectorsearch_cities
59-
# Since Dart 3.7, dart format needs pub get to run before formatting,
60-
# so can no longer check formatting of Flutter packages (would require Flutter SDK):
61-
# Check formatting only for Dart packages
62-
- dart format --set-exit-if-changed benchmark
63-
- dart format --set-exit-if-changed generator
64-
- dart format --set-exit-if-changed objectbox
65-
- dart format --set-exit-if-changed objectbox_test
66-
- dart format --set-exit-if-changed objectbox/example/dart-native
6767

6868
# Runs generator integration tests, e.g. ensures generator works as expected.
6969
# Note: no need to test oldest SDK here, generator package is also built as part of unit-tests job.

0 commit comments

Comments
 (0)