Skip to content

Commit f7f6d6b

Browse files
committed
Exclude <4.3 builds, allow more time to startup (macOS)
1 parent 367efa2 commit f7f6d6b

File tree

3 files changed

+23
-18
lines changed

3 files changed

+23
-18
lines changed

.github/other/check-example.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ set -euo pipefail
1212
# Opening in editor can take a while (import reosurces, load extensions for the first time, ...).
1313
# Unlike EXAMPLE_TIMEOUT, this is an upper bound, after which CI job fails, so not the entire time is necessarily spent.
1414
EXAMPLE_TIMEOUT=5
15-
EDITOR_TIMEOUT=30 # already encountered 20s on macOS CI.
15+
EDITOR_TIMEOUT=60 # already encountered 20s on macOS CI.
1616

1717
example="$1"
1818
if [ -z "$example" ]; then

.github/workflows/ci.yml

+10-17
Original file line numberDiff line numberDiff line change
@@ -177,23 +177,16 @@ jobs:
177177
artifact-name: linux-4.3
178178
godot-binary: godot.linuxbsd.editor.dev.x86_64
179179

180-
- name: linux-4.2
181-
os: ubuntu-22.04
182-
artifact-name: linux-4.2
183-
godot-binary: godot.linuxbsd.editor.dev.x86_64
184-
rust-extra-args: --features godot/api-4.2
185-
186-
- name: linux-4.1
187-
os: ubuntu-22.04
188-
artifact-name: linux-4.1
189-
godot-binary: godot.linuxbsd.editor.dev.x86_64
190-
rust-extra-args: --features godot/api-4.1
191-
192-
# Do not run memchecks; increases CI complexity too much with the patching and everything.
193-
# Such cases need to be tested in the itest suite in the main repo.
194-
195-
# Also don't test double precision. Makes a lot of code more difficult to write (real conversions etc), missing
196-
# the point of examples being approachable. Users who need it are trusted to adjust code based on compile errors.
180+
# Deliberately don't include:
181+
#
182+
# * Memchecks: increases CI complexity too much with the patching and everything.
183+
# Such cases need to be tested in the itest suite in the main repo.
184+
#
185+
# * Double precision. Makes a lot of code more difficult to write (real conversions etc), missing the point of examples
186+
# being approachable. Users who need it are trusted to adjust code based on compile errors.
187+
#
188+
# * Godot versions older than latest stable: require "least common denominator" compromises, not being able to showcase new features.
189+
# Also, opening projects in newer editor versions frequently causes warnings.
197190

198191

199192
steps:

ReadMe.md

+12
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,16 @@ We currently feature the following example projects:
2323
Showcases how classes and their state can be hot-reloaded in the Godot editor.
2424

2525

26+
## Godot version
27+
28+
Examples are written to work with **latest stable** Godot version. When a new minor/patch version is released, we generally try to update it
29+
within a few days or weeks.
30+
31+
We additionally run CI with newer in-dev versions, but that support is best-effort. Examples do not provide compatibility with older Godot
32+
versions, as the projects need migration and this would prevent us from showcasing newer versions. godot-rust itself however offers support
33+
for older versions, see [Compatibility and Stability][book-compatibility].
34+
35+
2636
## Contributions
2737

2838
If you would like to contribute an example, please open an issue **before** submitting a big pull request.
@@ -38,3 +48,5 @@ Like the library, all contributions are subject to the [Mozilla Public License 2
3848
[Website]: https://godot-rust.github.io
3949
[Book]: https://godot-rust.github.io/book
4050
[mpl]: https://www.mozilla.org/en-US/MPL
51+
[book-compatibility]: https://godot-rust.github.io/book/toolchain/compatibility.html
52+
```

0 commit comments

Comments
 (0)