v0.1.0 Release

[OpenBagTwo]

Summary

Release staging for EnderChest v0.1.0

List of Changes

• Implements Milestone 2: Shulker Boxes
• Fleshes out the docs for the project
  • and automatically refreshes them on every merge to dev or release
• EnderChest is now published to PyPI on every new release
• The README and docs now contain numerous badges indicating the compatible operating systems and versions of Python
  • with this matrix being tested via GitHub Actions
  • and with code quality badges being regenerated on every merge to dev

Tech Debt and Other Concerns

• This release marks a regression from v0.0.4 in that it removes first-class support for server linking (though servers can still be linked via manual instance creation) (Server syncing and linking #66)

• From Implement Syncing #41:

  the wait-five-seconds-before-doing-anything is annoying and unhelpful, but until I've dogfooded this implementation for a bit, I'm just not sure what I'm going to want the default implementation to be.

  (Improve the messages displayed when syncing EnderChests #57)

• Using rsync under Windows is currently undocumented and untested, if it's even generally possible (Instructions for Setting Up Rsync on Windows #67)

• Documentation is definitely needed describing how to uninstall EnderChest and replace all the symlinks with the real files (EnderChest Offboarding #51)

To Do

• enderchest gather syntax is ambiguous #47
• contributor guide needs to cover mkdocs
• fix PR template typo ("changes is")
• EnderChest places links to shulker box configs #49

Validation Performed

This release will not be cut until I've transitioned my existing EnderChest installations across my various machines and eaten my own dogfood for at least a little bit.

For #47 specifically:

• Running enderchest -h shows the verb as gather minecraft (it was almost going to be gather minecrafts 😬 )
• Running enderchest gather -h shows the main help message
• Running enderchest gather instances (from a folder that actually has an "instances" folder) spits out:

  usage: enderchest gather minecraft [-h] [--root ROOT_FLAG] [--verbose] [--quiet] [--official | --mmc] [root] search_paths [search_paths ...]
  enderchest gather minecraft: error: the following arguments are required: search_paths

PR Type

• This PR introduces a breaking change (will
  require a bump in the minor version)
• The changes is high urgency and necessitates a hotfix or patch release
  (will require rebasing off of release)
• This is a release (staging) PR (maintainer use only)

Checklist:

• I have read the contributor's guide
• I have run mkdocs serve locally and ensured that all API docs and
  changes I have made to the static pages are rendering correctly, with all links
  working
• All tech debt concerns have been resolved, documented as issues, or otherwise
  accepted
• I agree to license my contribution to this project under
  the GNU Public License v3

[OpenBagTwo]

Dogfooding update: I've now got two computers all set up with EnderChests, encompassing 29 shulker boxes (and no, I definitely don't have 29 instances, even spread across both machines).

Is this an improvement over the old system? I mean, #23 aside, it's definitely a lot more difficult to tell where everything is and to guard against duplicates. But I've captured that point in #50, and what I've already observed is that bootstrapping a new instance (which was incredibly painful with v0.0.4) will be much easier now. Especially when using something like PrismLauncher which can fetch any mods that you're missing. Even updating mods (#24) is kinda nice because you just do an enderchest place -k, and you can see right away all the mods that need to be moved upstream just by looking at the list of broken links.

[OpenBagTwo]

Okay, it's release time. Let's see if I can do this correctly. I believe the order of ops is:

1. Merge
2. Kill docs build
3. Cut release off release
4. Rerun docs build (aha! It's all coming back to me now...)
5. Rebase dev off of release

Gonna document the process here so I can find it the next time.

[OpenBagTwo]

Oh wait. Pause. Minecraft 1.20-rc1 just dropped. Let's make sure it doesn't break anything.

[OpenBagTwo]

Well my mod appears to be broken, but it linked just fine (along with the world and resourcepacks, etc.)

[OpenBagTwo]

Yeah, so release-docs-push failed:

error: version 'release' already exists

So I'll have to do this manually for now. Odd that dev never had this problem...

[OpenBagTwo]

Ah, bless you, mike:

If [version] already exists, this command will also update all of the pre-existing aliases for it. Normally, if an alias specified on the command line is already associated with another version, this will return an error. If you do want to move an alias from another version to this version (e.g. when releasing a new version and updating the latest alias to point to this new version), you can pass -u/--update-aliases to allow this.