Differences

This shows you the differences between two versions of the page.

--- publishing_mods_using_github_actions [2022/11/14 13:35] – xipit
+++ tutorial:publishing_mods_using_github_actions [2022/11/19 18:09] – Adjust title to be closer to similar tutorials xipit
@@ Line 1: / Line 1: @@
-====== Publishing your mod on Curseforge, Modrinth & Github using the MC-Publish Github Action by Kir-Antipov ======
+====== Publishing mods on Curseforge, Modrinth & Github with MC-Publish ======
-MC-Publish is a Github Action that communicates with Github, Curseforge and Mordrinth APIs to upload your mod files. This page only goes through the basics of the set-up and you should [[https://github.com/Kir-Antipov/mc-publish#publish-minecraft-mods---github-action|check out its Github documentation for further information]].
+MC-Publish is a Github Action by Kir-Antipov that communicates with Github, Curseforge and Mordrinth APIs to upload your mod files. This page only goes through the basics of the set-up and you should [[https://github.com/Kir-Antipov/mc-publish#publish-minecraft-mods---github-action|check out its Github documentation for further information]].
 ===== What are Github Actions? =====
@@ Line 242: / Line 242: @@
   * Authentication tokens stored as secrets in your github repository
   * a ''.yml'' file in ''/.github/workflows'' pushed to your github repository
-  * a empty ''CHANGELOG.MD'' file in your project root
+  * a empty ''CHANGELOG.md'' file in your project root
 If you have all these you are finished! You can now use your newly created Github Action to deploy updates for your mod!
@@ Line 248: / Line 248: @@
 ===== Additional tips =====
+Here is a list of useful resources that didn't fit into the general tutorial.
+==== Update Checklist ====
+When updating your mod you now have a few places you need to look at.
+  * update the version number
+     * in ''src/fabric.mod.json'' under ''"version": "1.1.0+1.19.2"''
+     * in ''gradle.properties'' (typically) under ''mod_version = 1.1.0+1.19.2''
+     * in ''.github/workflows/publish.yml'' under ''VERSION: 1.1.0+1.19.2'' and ''RELEASE_NAME: Example Mod 1.1.0 for Minecraft 1.19.2''
+  * update the changelog in ''CHANGELOG.md''
+  * (if you use the recommended workflow) Merge the update branch into the current default branch
+==== Handling dependencies ====
+[[https://github.com/Kir-Antipov/mc-publish#dependencies|Check out the official documentation]]. I recommend using the ''fabric.mod.json'' approach.
+==== Errors when uploading to Modrinth ====
+Since Modrinth updated its API some people have problems uploading through the API. If that happens to you, try separating the modrinth portion from Github and Curseforge. You can do this easily by copying the MC-Publish step and trimming out the now unecessary input in ''with''. You should now have two separate steps.
+Change the version in the step that publishes to modrinth to 2.1 -> ''uses: Kir-Antipov/mc-publish@v2.1''