Skip to content

Commit

Permalink
ci: use Kir-Antipov/mc-publish for releases (#23)
Browse files Browse the repository at this point in the history
* docs: extend README

* gradle: use `x.y.z+mcx.y.z` version format

* ci: use Kir-Antipov/mc-publish for releases

* ci: tidy up build workflow
  • Loading branch information
getchoo authored Jul 31, 2024
1 parent 243b8bb commit 289296c
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 17 deletions.
21 changes: 16 additions & 5 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,23 @@ name: CI
on:
push:
branches: [main]
paths:
- "src/**"
- "gradle/**"
- "**.gradle"
- "gradlew*"
- "gradle.properties"
tags-ignore:
- "**"

pull_request:
paths:
- "src/**"
- "gradle/**"
- "**.gradle"
- "gradlew*"
- "gradle.properties"

workflow_dispatch:
workflow_call:

Expand All @@ -20,11 +34,8 @@ jobs:

strategy:
matrix:
# Use these Java versions
java: [
21, # Current Java LTS & minimum supported by Minecraft
]
# and run on both Linux and Windows
java:
- 21 # Current Java LTS & minimum supported by Minecraft
os: [ubuntu-latest, windows-latest]

runs-on: ${{ matrix.os }}
Expand Down
40 changes: 30 additions & 10 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,31 +1,51 @@
name: Release

on:
push:
tags:
- "*"

permissions:
contents: write
release:
types: [published]

jobs:
build:
uses: ./.github/workflows/build.yml

make-release:
name: Create release
name: Create
needs: build

runs-on: ubuntu-latest

permissions:
contents: write

steps:
- name: Download artifacts
uses: actions/download-artifact@v4
with:
name: jars
path: jars

- name: Create Release
uses: softprops/action-gh-release@v1
uses: Kir-Antipov/mc-publish@v3
env:
VERSION: ${{ github.ref_name }}
with:
draft: true
files: threadtweak*.jar
modrinth-id: threadtweak
modrinth-featured: true
modrinth-unfeature-mode: any
modrinth-token: ${{ secrets.MODRINTH_TOKEN }}

github-tag: ${{ github.ref_name }}
github-token: ${{ github.token }}

files: |
jars/!(*-@(dev|sources|javadoc)).jar
jars/*-@(dev|sources|javadocs).jar
name: ThreadTweak ${{ env.VERSION }}
version: ${{ env.VERSION }}
version-type: release
changelog: ${{ github.event.release.body }}

loaders: |
fabric
quilt
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# ThreadTweak

Improve and tweak Minecraft CPU scheduling (again!)
[![github](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/github_vector.svg)](https://github.com/skywardmc/threadtweak)
[![fabric](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/fabric_vector.svg)](https://fabricmc.net)
[![quilt](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/quilt_vector.svg)](https://quiltmc.org)

ThreadTweak lets you improve and tweak Minecraft CPU scheduling. It is a maintained version of the [original Smooth Boot mod](https://github.com/UltimateBoomer/mc-smoothboot), allowing you to still change CPU thread priorities in-game.

## Features

Expand All @@ -10,6 +14,31 @@ Improve and tweak Minecraft CPU scheduling (again!)

For more information, please read the [Smooth Boot Wiki](https://github.com/UltimateBoomer/mc-smoothboot/wiki).

## FAQ

### Why was this made if it's no longer needed?

While the main function of Smooth Boot was fixed in 1.19.4, the mod still allows you to adjust thread priorities, which can still be quite beneficial on some systems as shown in [UltimateBoomer/mc-smoothboot #54](https://github.com/UltimateBoomer/mc-smoothboot/issues/54).

### Is this faster than the original mod?

Not in any way - this is only a maintained version of the final version of Smooth Boot. There may or may not be extra features or improvements added as requested or while I have the time.

## Special Thanks

[UltimateBoomer](https://github.com/UltimateBoomer) was the original creator of [Smooth Boot](https://github.com/UltimateBoomer/mc-smoothboot), which this project is based on. Much credit should go to them for originally creating and maintaining it for so long :)

<details>
<summary>Email with permission from the original author</summary>

>
> Hello Devin,
>
> I certainly have no problems if you want to maintain a fork of Smooth Boot for future versions of Minecraft. I understand that Smooth Boot can still be useful in version 1.20 and later, though personally I'm not interested in maintaining the mod right now. I also suggest a different name to be used, though you don't have to if you don't want to. Smooth Boot's original purpose of making Minecraft launch faster is no longer necessary, so a different name would convey the purpose of the mod more accurately.
>
> Thanks,
>
> UltimateBoomer
</details>

2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ plugins {
id 'fabric-loom' version '1.6-SNAPSHOT'
}

version = "${project.minecraft_version}-${project.mod_version}"
version = "${project.mod_version}+mc${project.minecraft_version}"
group = project.maven_group

repositories {
Expand Down

0 comments on commit 289296c

Please sign in to comment.