Skip to content

Commit

Permalink
Add internal docs
Browse files Browse the repository at this point in the history
  • Loading branch information
OliverSchlueter committed Jan 4, 2024
1 parent 71c5c45 commit 83ace37
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 0 deletions.
12 changes: 12 additions & 0 deletions Writerside/i.tree
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE instance-profile
SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">

<instance-profile id="i"
name="internal"
start-page="internal.md" is-library="true">

<toc-element topic="internal.md"/>
<toc-element topic="I-New-Minecraft-version.md"/>
<toc-element topic="I-Releases.md"/>
</instance-profile>
25 changes: 25 additions & 0 deletions Writerside/topics/I-New-Minecraft-version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Updating to a new Minecraft version

## Pre-release phase

While mojang is still publishing pre-releases, check in the mc source for potential problems & breaking changes.

## Preparing

Do this before paper released the first dev bundle.

1. copy the ``implementation_(PREVIOUS VERSION)`` module
2. paste the module and change the version ('1_20_2' -> '1_20_3')
3. add ``include("implementation_(NEW VERSION)")`` to settings.gradle.kts
4. add ``implementation(project(":implementation_(NEW VERSION)", configuration = "reobf"))`` in build.gradle.kts
5. add the new version in Plugin#onLoad and Plugin#SUPPORTED_VERSIONS
6. (add the new version in AttributeManagerImpl#init)
7. update the latest version in README

## Actually updating

1. update ``mcVersion`` in build.gradle.kts
2. update ``minecraftVersion`` in the new implementation module
3. test if it compiles
4. fix compile & mapping errors
5. [publish new plugin version](I-Releases.md) and hope nothing is broke
14 changes: 14 additions & 0 deletions Writerside/topics/I-Releases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Releases

1. change the version in ``./build.gradle.kts``
2. commit & push
3. publish api to maven-repo (the ``api`` module only)
4. run jenkins build
5. create a github release
1. create a new tag (v.1.2.3)
2. title: just the version
3. attach the compiled jar
6. create spigotmc release
7. create hangar release
8. create modrinth release
9. make discord announcement
3 changes: 3 additions & 0 deletions Writerside/topics/internal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Internal docs

This is a collection of internal documentation for the FancyNpcs & FancyHolograms projects.
1 change: 1 addition & 0 deletions Writerside/writerside.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@
<categories src="c.list"/>
<vars src="v.list"/>
<instance src="fp.tree"/>
<instance src="i.tree" web-path="/i/" version="1.0"/>
</ihp>

0 comments on commit 83ace37

Please sign in to comment.