-
Notifications
You must be signed in to change notification settings - Fork 0
Retire mkdocs, publish plugins to Reposilite, refresh docs #29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -43,7 +43,10 @@ dependencies { | |
| } | ||
| ``` | ||
|
|
||
| Shared bundle install: | ||
| Standalone install: `magicutils-fabric-bundle` is also a runnable Fabric mod on | ||
| its own — drop the jar into `mods/` and it boots the shared MagicUtils runtime | ||
| and registers the `/magicutils` (alias `/mu`) command with diagnostics | ||
| sub-commands, no host mod required. Depend on it from your mod with: | ||
|
|
||
| ```kotlin | ||
| dependencies { | ||
|
|
@@ -124,8 +127,9 @@ https://magicutils.theroer.dev/getting-started/quickstart/ | |
|
|
||
| ## Notes | ||
|
|
||
| - GitHub Pages Maven does not host `*-all` shaded artifacts. Use the thin jars | ||
| from Maven or build shaded jars locally when you need them. | ||
| - Artifacts are published to the self-hosted Reposilite at | ||
| `https://maven.theroer.dev/releases`. Both the thin jars and the `*-all` | ||
| shaded jars (where produced) are available there. | ||
|
|
||
| ## Reflection Automation | ||
|
|
||
|
|
@@ -142,14 +146,14 @@ new reflection usage automatically. | |
|
|
||
| ## Release Helper | ||
|
|
||
| Maintainers can prepare and dispatch a tagged release with: | ||
| Maintainers cut a tagged release with the Gradle release tasks (the former | ||
| `scripts/publish_release.py` is deprecated): | ||
|
|
||
| ```bash | ||
| python3 scripts/publish_release.py 1.19.2 --dry-run | ||
| python3 scripts/publish_release.py 1.19.2 | ||
| ./gradlew releasePreflight -Pversion=X.Y.Z # validate version + tags, no changes | ||
| ./gradlew release -Pversion=X.Y.Z # preflight → bump → dispatch release.yml | ||
| ``` | ||
|
|
||
| The helper mirrors the GitHub Actions flow: it can sync `gradle.properties`, | ||
| push the selected branch, wait until `origin/<ref>` resolves to the pushed | ||
| commit, and then dispatch `release.yml`. Optional flags are available for | ||
| manual `javadoc.yml` and `publish-maven.yml` dispatches when needed. | ||
| `release` validates the version, bumps `gradle.properties`, commits, and | ||
| dispatches `release.yml`. CI then tags `vX.Y.Z`, builds docs/javadoc, and | ||
| publishes the artifacts to Reposilite. See `RELEASING.md` for the full flow. | ||
|
Comment on lines
+157
to
+159
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. issue: Clarify whether CI still builds docs here or only publishes Javadoc/artifacts, to keep the release description consistent. Since this repo no longer contains the docs workflows and |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue (bug_risk): The
versioninput passed topublish-maven.ymlis not defined in that workflow and will causegh workflow runto fail.publish-maven.ymldefines onlyon: workflow_dispatchand noinputs. Passing-f version="$VERSION"togh workflow runwill therefore fail with "workflow does not accept input 'version'". Please either add aworkflow_dispatch.inputs.versiontopublish-maven.ymland use it, or remove the-f versionflag from this invocation.