Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/lucee/lucee-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
michaeloffner committed Aug 5, 2024
2 parents 9694d2d + 01649c8 commit 318a146
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 106 deletions.
8 changes: 4 additions & 4 deletions docs/00.home/homepage.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ To find out more about getting involved as a developer with Lucee, checkout our

## Lucee 6.1

Lucee 6.1 is the next major release, currently at the final Release Candidate stage.
Lucee 6.1 is current stable release of Lucee.

Targeting better performance and reduced memory usuage, Lucee 6.1 now has full support for Java 11 thru 21.
Targeting better performance and reduced memory usuage, Lucee 6.1 has full support for Java 11 and 21.

## Lucee 6.0

[Lucee 6](https://dev.lucee.org/tag/lucee-6) is current stable release of Lucee.
[Lucee 6](https://dev.lucee.org/tag/lucee-6) .

Highlights include, reduced size, faster startup, single context mode, JSON based configuration and much more.

Expand All @@ -34,7 +34,7 @@ As a Major Release, Lucee 6 does include some potential **BREAKING CHANGES**, fo

Lucee 5.4 is our [LTS stable release](https://lucee.org/downloads.html) and is recommended for production systems. More details are available in the [Lucee 5](/guides/lucee-5.html) section of these docs.

Lucee 5.4 will receive security updates and critcal regression fixes until 2026, but is no longer actively maintained.
As a LTS release, Lucee 5.4 will receive security updates and critical regression fixes until 2026, **but is no longer actively maintained.**

## Getting help

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ Of course there are different recommendations that go with the different operati

### Java Versions ###

Lucee 5.3 and 5.4 support Java 8 and 11
Lucee 5.4 (LTS) supports Java 8 and 11

Lucee 6 will support Java 11 on release, with Java 8 unofficially supported as long as practical
Lucee 6 supports Java 11, with Java 8 unofficially supported as long as practical

Full Java 17 support is planned for a later 6 point release, it currently mostly works, see <https://luceeserver.atlassian.net/browse/LDEV-3807>
Lucee 6.1 supports Java 11 and Java 21 (recommended)

Lucee 6.2 will support both the Javax and Jakarta Namespaces, thus supporting Tomcat 10 etc

If you do run into problems running on **newer versions** of Java with Lucee 6, please report any problems to the developer forum [Lucee Dev](https://dev.lucee.org)

Expand Down
29 changes: 23 additions & 6 deletions docs/04.guides/05.working-with-source/01.build-from-source/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,16 @@ See [[building-testing-extensions]] for instructions regarding Extensions

### 1. Before you get started

Lucee 5.4 is in LTS mode, any new submissions should target the 6.2 branch

Before you can start building Lucee from source, you will need a few things installed on your machine:

1. **Java JDK** - since you're going to compile Java code you need the JDK and not just the JRE.

- Lucee requires JDK 8 or later in order to compile. [Oracle](https://www.oracle.com/technetwork/java/javase/downloads/) or [AdoptOpenJDK](https://adoptopenjdk.net/)
- Java 11 is *recommended*, Java 15 is *not yet supported* due the removal of the Nashorn JavaScript engine which is used in the build process
- Java 17 *isn't yet fully supported* due to some Apache Felix issues (fixed in 5.3.9, but some extensions need updating)
- Lucee requires JDK 11 or later in order to compile. [Oracle](https://www.oracle.com/technetwork/java/javase/downloads/) or [AdoptOpenJDK](https://adoptopenjdk.net/)
- Java 8 still works, but is no longer officially supported as of Lucee 6.0
- Java 11 is supported
- Java 21 is fully supported since 6.1

1. **Apache Maven** - the source code contains several build scripts that will automate the build process for you. You will need Maven installed in order to run these build scripts. <http://maven.apache.org/>

Expand All @@ -28,11 +31,25 @@ Before you can start building Lucee from source, you will need a few things inst

Lucee's source code is version-controlled with Git, [Lucee GitHub repository](https://github.com/lucee/lucee).

The repository contains a few branches, with the most important ones being "Master" (current release) and "Develop" (alpha and beta releases), currently the main branch for development is the *6.0 branch*, so best start there.
The repository contains a few branches, with the most important ones being "Master" (current release) and "Develop" (alpha and beta releases), currently the main branch for development is the *6.1 branch*, so best start there.

So fork the Lucee repo and then checkout your forked repo locally

**Important**

Recently (July 2024) we experienced a problem with Docker pull limits being hit, causing our CI (Github Actions) to fail

Docker kindly sponsored Lucee with an open source license, so we are now using authenticated Docker pulls,
however, this causes a problem on CI for PRs and forks, as the Github Action will fail without Docker Creds (secrets)

To solve this, you'll need a Docker hub account and add the following secrets to your forked repo

- DOCKERHUB_PUBLIC_USERNAME
- DOCKERHUB_PUBLIC_TOKEN

So simply clone the 6.0 branch (or fork your own copy) from the git repository to your local drive with the following command:
(it's named "PUBLIC" as this token under the Lucee Org only has rights to pull public images)

git clone -b 6.0 https://github.com/lucee/Lucee.git
See <https://luceeserver.atlassian.net/browse/LDEV-4979> for details.

### 3. Build it

Expand Down
Loading

0 comments on commit 318a146

Please sign in to comment.