From ea4271ebefce429e53b96e6bc6dd63e518cfa4ed Mon Sep 17 00:00:00 2001 From: shartte Date: Thu, 15 Aug 2024 20:07:19 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 69ba6649..7bdb9d9b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@ NeoForm provides steps to create reproducible and recompilable Minecraft source # How to Use Development versions of Minecraft for a release version will be on a branch named `-dev` -Definitions: +##Definitions + * `type` can be either * `release` (release versions) * `pre` (pre-releases and release candidates) @@ -12,21 +13,29 @@ Definitions: * `ver` is a major version of Minecraft without the ending `.` (e.g. the value for 1.21.1 is 1.21) * `version` is a specific version of Minecraft -options in `local.properties` can be set to filter for which versions are loaded by gradle: +## Local Settings + +Options in `local.properties` can be set to filter for which versions are loaded by gradle: * `type` (defaults to `release`) * `ver` (defaults to all major versions) -Gradle tasks: +## Gradle Tasks + * `::projectApplyAll` - Creates Minecraft source code of that version with patches applied * `::projectMakeAll` - Generates patches for the specified version * `update` - Requires `old_version` and `new_version` to be specified in `gradle.properties` in the format of `//`. Sets up the new version based on the old version without the patches from the old version * `::testJdks` - Checks that the generated source code is consistant across java versions along with compilation -GitHub Actions Variables -* `TARGET_MC_VERSION` - Should be set at the start of a new snapshot series to the name of the release version +## GitHub Actions Variables + +Some workflows need to know which release-version the current series of snapshots will result in. + +We set the GitHub Actions variable `TARGET_MC_VERSION` for this purpose in the [project settings](https://github.com/neoforged/NeoForm/settings/variables/actions). + +If we suspect that the current series of snapshots will be released as Minecraft 1.21.2 for example, this variable should be set to '1.21.2'. -# GitHub Actions Workflows +## GitHub Actions Workflows * `Check For New Snapshots` - Runs every 30 minutes from 6am to 7pm UTC and checks for when Mojang releases a new version and runs the `Update` workflow * `Update` - Runs the `update` task and checks for any library updates along with copying over the patches from the old version to the new version then attempts to run the `Check` workflow. Parameters: * `Old branch` - The branch name where the old version is From 2e4c2df27170c3622046b6425b211ba4aa65ee82 Mon Sep 17 00:00:00 2001 From: shartte Date: Thu, 15 Aug 2024 20:08:13 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7bdb9d9b..23df0b2e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ NeoForm provides steps to create reproducible and recompilable Minecraft source # How to Use Development versions of Minecraft for a release version will be on a branch named `-dev` -##Definitions +## Definitions * `type` can be either * `release` (release versions) From 0f5152406873c2f6b749aaa8991ab8c8b6ef82d6 Mon Sep 17 00:00:00 2001 From: shartte Date: Thu, 15 Aug 2024 20:08:50 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 23df0b2e..0b55e4e5 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Some workflows need to know which release-version the current series of snapshot We set the GitHub Actions variable `TARGET_MC_VERSION` for this purpose in the [project settings](https://github.com/neoforged/NeoForm/settings/variables/actions). -If we suspect that the current series of snapshots will be released as Minecraft 1.21.2 for example, this variable should be set to '1.21.2'. +If we suspect that the current series of snapshots will be released as Minecraft 1.21.2 for example, this variable should be set to `1.21.2`. ## GitHub Actions Workflows * `Check For New Snapshots` - Runs every 30 minutes from 6am to 7pm UTC and checks for when Mojang releases a new version and runs the `Update` workflow