[ForgeGradle] Publish project to GitHub Packages

[GenElectrovise]

How can I publish my mod project to a GitHub package?

 

I noticed that Forge already has a publishing section in build.gradle, but some of it clashes with the GitHub documentation on this, so I figured Forge might have some requirements for this?

 

If there is, in fact, nothing special to do, just say and I'll go back to the Gradle and GitHub docs but I thought it'd be good to ask here first

 

Edit:

The "clashes" I mentioned:

https://docs.github.com/en/packages/guides/configuring-gradle-for-use-with-github-packages

publications {
        gpr(MavenPublication) {
            from(components.java)
        }
    }

 

https://github.com/GenElectrovise/MagiksMostEvile/blob/feature/1.16.4/kitty_the_kraken/build.gradle (Default Forge build.gradle - see line 144)

publications {
        mavenJava(MavenPublication) {
            artifact jar
        }
    }

 

Edited January 15, 2021 by GenElectrovise

[DaemonUmbra]

The bit before the (MavenPublication) is simply the name of the publication.

The bit inside the brackets is what gets published, GitHub is suggesting publishing everything built from Java, which may or may not be what you want, I recommend testing by publishing to mavenLocal or mcmodsrepo first.

 

All in all GitHub Packages should just be a maven that requires authentication

[GenElectrovise]

Thanks @DaemonUmbra - while this thread has been silent I've been wrangling with Gradle...

I had a lot of trouble (authenticating?) with the maven publishing, so in the end, I have activated the maven (as opposed to maven-publish) plugin, and have set it up like so, which works well.

 

It requires that I run that uploadArchives command, rather than publish, which I hope won't cause errors with jar re/obfustication (first two lines of snippet).

 

From the tasks that are run, I can see that the jar is, in fact, reobfusticated prior to uploading (as part of the build process), so I suppose that I'll have to wait and see for the future as to what will work and what not...

 

jar.finalizedBy('reobfJar') 
//publish.dependsOn('reobfJar')

publishing {
	
}

configurations {
	deployerJars
}

uploadArchives {
	repositories {
		mavenDeployer {
			configuration = configurations.deployerJars
			repository(url: "https://maven.pkg.github.com/GenElectrovise/MagiksMostEvile") {
				authentication(userName: project.githubGenElectroviseUsername, password: project.githubGenElectroviseToken)
			}
		}
		
		mavenDeployer {
			repository(url: "file:///${project.projectDir}/mcmodsrepo")
		}
	}
}

 

[DaemonUmbra]

maven-publish is preferred and I was able to get it working

[GenElectrovise]

@DaemonUmbra

Yes... I would prefer 'maven-publish'... I kept getting the error "Could not write to resource", and Stackoverflow was incredibly unhelpful on the subject...

'maven' is kind of a stand-in right now...

Could you send your working publication/build.gradle? The issue is probably with me authenticating but syntax is always an option.

 

Note: Where are you storing credentials? Naturally they shouldn't be in the project sources, so I'm keeping them in my master User/.gradle/gradle.properties. They seem to be being located there. Are you using a Personal Access Token or standard login credentials? I believe that a PAT is preferred by Github? 

 

EDIT:
A PAT is required https://docs.github.com/en/packages/guides/configuring-gradle-for-use-with-github-packages

Edited January 20, 2021 by GenElectrovise

[GenElectrovise]

Uhhh ok then.

This is very strange.

It now works for me too.

I... uhh... ok then  

Thanks!?

 

It seems to only store one package at a time? Maybe it only shows the most recent - who knows! I'll look around for this...

 

build.gradle

publishing {
    repositories {
        maven {
            name = "GitHubPackages"
            url = uri("https://maven.pkg.github.com/genelectrovise/magiksmostevile") // MUST BE --ALL-- LOWER CASE
            credentials {
                username = project.findProperty("gpr.user") ?: System.getenv("GITHUB_USERNAME")
                password = project.findProperty("gpr.key") ?: System.getenv("GITHUB_TOKEN")
            }
        }
		
        maven {
            name = "LocalMaven"
            url = uri("file:///${project.projectDir}/mcmodsrepo")
        }
    }
	
    publications {
        gpr(MavenPublication) {
            groupId = group
            artifactId = archivesBaseName
            version = version
            artifact jar
        }
    }
}

 

gpr.user and gpr.key are secrets contained in my User/.gradle/gradle.properties.

They are defined like so:

gpr.user=INSERT_USERNAME_HERE
gpr.key=INSERT_SECRET_PERSONAL_ACCESS_TOKEN_HERE

 

[DaemonUmbra]

I seem to recall getting this error myself... I think it had something to do with caps, also I do what GitHub suggests and put those in a gradle.properties in my user folder so they're global and there's no risk of accidentally committing them