enso/docs/infrastructure/upgrading-graalvm.md

43 lines
1.8 KiB
Markdown
Raw Normal View History

2020-08-28 14:03:09 +03:00
---
layout: developer-doc
title: Upgrading GraalVM
category: infrastructure
tags: [infrastructure, build, graalvm, graal, jvm]
order: 5
---
# Upgrading GraalVM
After upgrading the project to a newer version of GraalVM, all developers must
take the following actions to be able to continue development after the upgrade:
1. Download the new JVM version and set it as the default for the project. If
you use IntelliJ, you will also need to update the JVM used for the project
in the project settings.
2. Re-run `sbt bootstrap` to get the updated Truffle JAR (if there are issues
updating, removing `engine/runtime/build-cache` directory may help).
3. Do a full clean (it may not _always_ be required, but not doing it often
leads to problems so it is much safer to do it) by running `enso/clean`.
4. To be able to build or run tests for the `launcher` project, Native Image for
the new GraalVM version has to be installed, as it is not included by
default. This can be done with
`<path-to-graal-home>/bin/gu install native-image`.
- If there are problems building the Native Image, removing
`engine/launcher/build-cache` (which contains the downloaded `musl`
package) may help.
## Upgrading the Build
If you are upgrading the _build_ to a new GraalVM version, you additionally need
to perform the following tasks:
- Change the expected GraalVM version in the [`build.sbt`](../../build.sbt)
configuration. This is both a version number and (if it is changed), the
associated version of Java.
- Change the expected GraalVM version in the
[`scala.yml`](../../.github/workflows/scala.yml) and
[`release.yml`](../../.github/workflows/release.yml) workflows.
- Change the base image in the [`Dockerfile`](../../tools/ci/docker/Dockerfile)
to contain the correct GraalVM version.
- Ensure that all deprecations have been handled.