Skip to content

Commit

Permalink
feat: refactor path names and improved the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelHillcox committed Aug 12, 2024
1 parent 11372b1 commit c30e538
Show file tree
Hide file tree
Showing 12 changed files with 68 additions and 29 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/base.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ jobs:
uses: gradle/gradle-build-action@v2
env:
SNAPSHOT: ${{ inputs.use-snapshots }}
SAPS_TOKEN: ${{ secrets.saps-token }}
NANITE_TOKEN: ${{ secrets.nanite-token }}
with:
arguments: publish
2 changes: 1 addition & 1 deletion .github/workflows/releases.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ jobs:
with:
use-snapshots: false
secrets:
saps-token: ${{ secrets.SAPS_TOKEN }}
NANITE_TOKEN: ${{ secrets.nanite-token }}
2 changes: 1 addition & 1 deletion .github/workflows/snapshot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ jobs:
with:
use-snapshots: true
secrets:
saps-token: ${{ secrets.SAPS_TOKEN }}
nanite-token: ${{ secrets.NANITE_DEPLOY }}
47 changes: 44 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,57 @@ This is a simple gradle plugin that provides some nice to have features, some sp
## Features

- [x] Changelog generation based on a createachangelog.com schema
- Takes a segment of the changelog and generates a changelog based on that
- [x] Creates standard mod versions based on the current Minecraft version (NeoForge style)

That's it for now 😘 but more is coming!

Please see the maven for the latest version of the plugin.

```groovy
plugins {
id 'dev.nanite.plugins.insaniam' version '0.2.0-SNAPSHOT'
}
```

### Changelog generation

```groovy
insaniam {
changelog {
file = file('path/to/changelog.md')
versionPattern = ~/## \\[[^]]+]/ // This is the default pattern and can be omitted
fallbackValue = "No changelog provided" // This is the default value and can be omitted
version = "1.0.0" // This will pull from 'version' in the gradle project if omitted
}
}
def changelog = insaniamUtils.createChangelog() // This will create a changelog string that can be used in a task
}
```

### Version generation

```groovy
version = "1-beta"
insaniam {
minecraftVersion = "1.21" // This can be omitted if you have a `minecraft_version` in your gradle project
}
// This will produce a version string like "21.0.1-beta" based on the Minecraft version in the style of NeoForge versioning
def modVersion = insaniamUtils.createModVersion() // This will create a mod version string that can be used in a task
// Sometimes you might just want to instantly change the version to the new one
// version = modVersion
}
```

## Usage

`build.gradle`
```groovy
plugins {
id 'pro.mikey.plugins.insaniam' version '0.1-SNAPSHOT'
id 'dev.nanite.plugins.insaniam' version '0.2.0-SNAPSHOT'
}
```

Expand All @@ -27,7 +68,7 @@ plugins {
pluginManagement {
repositories {
maven {
url 'https://maven.saps.dev/snapshots'
url 'https://maven.nanite.dev/snapshots'
}
gradlePluginPortal()
}
Expand Down
12 changes: 6 additions & 6 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ plugins {

val isSnapshot = providers.environmentVariable("SNAPSHOT").getOrElse("false").toBoolean()

group = "pro.mikey.plugins"
group = "dev.nanite.plugins"
version = "0.2.0${if (isSnapshot) "-SNAPSHOT" else ""}"
description = "Not sure yet"

Expand Down Expand Up @@ -46,8 +46,8 @@ gradlePlugin {
// testSourceSet(sourceSets["test"])

plugins.create("insaniam") {
id = "pro.mikey.plugins.insaniam"
implementationClass = "pro.mikey.insaniam.InsaniamPlugin"
id = "dev.nanite.plugins.insaniam"
implementationClass = "dev.nanite.plugin.InsaniamPlugin"
displayName = "Insaniam"
description = project.description
version = project.version
Expand All @@ -63,13 +63,13 @@ publishing {
}

repositories {
val token = providers.environmentVariable("SAPS_TOKEN")
val token = providers.environmentVariable("NANITE_TOKEN")

if (token.isPresent()) {
maven {
url = uri("https://maven.saps.dev/${if (isSnapshot) "snapshots" else "releases"}")
url = uri("https://maven.nanite.dev/${if (isSnapshot) "snapshots" else "releases"}")
credentials {
username = "errormikey"
username = "nanite"
password = token.get()
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
package pro.mikey.insaniam
package dev.nanite.insaniam

import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.reflect.TypeOf
import pro.mikey.insaniam.extensions.InsaniamExtension
import pro.mikey.insaniam.extensions.InsaniamUtils
import dev.nanite.insaniam.extensions.InsaniamExtension
import dev.nanite.insaniam.extensions.InsaniamUtils

@Suppress("unused")
class InsaniamPlugin : Plugin<Project> {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
package pro.mikey.insaniam.extensions
package dev.nanite.insaniam.extensions

import org.gradle.api.Action
import org.gradle.api.Project
import org.gradle.api.provider.Property
import org.gradle.api.tasks.Input
import pro.mikey.insaniam.types.ChangeLogData
import dev.nanite.insaniam.types.ChangeLogData
import javax.inject.Inject

abstract class InsaniamExtension @Inject constructor(private val project: Project) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package pro.mikey.insaniam.extensions
package dev.nanite.insaniam.extensions

import org.gradle.api.Project

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package pro.mikey.insaniam.types
package dev.nanite.insaniam.types

import org.gradle.api.Project
import org.gradle.api.file.RegularFileProperty
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
package pro.mikey.insaniam.test.integration.changelogs
package dev.nanite.insaniam.test.integration

import org.gradle.testkit.runner.BuildResult
import org.gradle.testkit.runner.TaskOutcome
import pro.mikey.insaniam.test.integration.IntegrationTest
import java.io.File
import kotlin.test.BeforeTest
import kotlin.test.Test
Expand All @@ -28,7 +27,7 @@ class ChangelogGeneratorTest : IntegrationTest {

@Test
fun `test single version changelog generation`() {
val result = createBaseGradleTask("./changelog-basic.md")
val result = createBaseGradleTask("changelog-basic.md")
val resultText = result.output

assertEquals(TaskOutcome.SUCCESS, result.task(":createChangelogTest")?.outcome)
Expand All @@ -37,7 +36,7 @@ class ChangelogGeneratorTest : IntegrationTest {

@Test
fun `test snipping changelog generation`() {
val result = createBaseGradleTask("./changelog-requires-splitting.md")
val result = createBaseGradleTask("changelog-requires-splitting.md")
val resultText = result.output

assertEquals(TaskOutcome.SUCCESS, result.task(":createChangelogTest")?.outcome)
Expand All @@ -47,7 +46,7 @@ class ChangelogGeneratorTest : IntegrationTest {

@Test
fun `test fallback changelog generation`() {
val result = createBaseGradleTask("./changelog-no-valid-target.md", true)
val result = createBaseGradleTask("changelog-no-valid-target.md", true)
val resultText = result.output

assertEquals(TaskOutcome.SUCCESS, result.task(":createChangelogTest")?.outcome)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package pro.mikey.insaniam.test.integration
package dev.nanite.insaniam.test.integration

import org.gradle.testkit.runner.BuildResult
import org.gradle.testkit.runner.GradleRunner
Expand All @@ -16,7 +16,7 @@ interface IntegrationTest {
val kotlinHeader = """
plugins {
java
id("pro.mikey.plugins.insaniam")
id("dev.nanite.plugins.insaniam")
}
// Injected empty task with a doLast to print the version
Expand All @@ -29,7 +29,7 @@ interface IntegrationTest {
val groovyHeader = """
plugins {
id 'java'
id 'pro.mikey.plugins.insaniam'
id 'dev.nanite.plugins.insaniam'
}
// Injected empty task with a doLast to print the version
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package pro.mikey.insaniam.test.integration.utils
package dev.nanite.insaniam.test.integration

import pro.mikey.insaniam.test.integration.IntegrationTest
import kotlin.test.Test
import kotlin.test.assertTrue

Expand Down

0 comments on commit c30e538

Please sign in to comment.