Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 0 additions & 35 deletions .github/workflows/docs-check.yml

This file was deleted.

77 changes: 0 additions & 77 deletions .github/workflows/docs.yml

This file was deleted.

89 changes: 0 additions & 89 deletions .github/workflows/javadoc.yml

This file was deleted.

13 changes: 6 additions & 7 deletions .github/workflows/publish-maven.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: publish-maven

on:
workflow_run:
workflows: ["docs"]
types: [completed]
# Dispatched by release.yml after the tag is created (documentation moved to
# the separate MagicUtilsWebsite project, so there is no docs workflow to chain
# from anymore). Also runnable manually.
workflow_dispatch:

# Publishing targets the self-hosted Reposilite (maven.theroer.dev) over HTTPS,
Expand All @@ -21,14 +21,13 @@ jobs:
# one-line edit to targets.properties — this workflow never lists targets.
resolve-matrix:
runs-on: ubuntu-latest
if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }}
outputs:
units: ${{ steps.matrix.outputs.units }}
repo_url: ${{ steps.coords.outputs.repo_url }}
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.workflow_run.head_sha || github.sha }}
ref: ${{ github.sha }}
- uses: actions/setup-java@v5
with:
distribution: 'temurin'
Expand Down Expand Up @@ -61,7 +60,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.workflow_run.head_sha || github.sha }}
ref: ${{ github.sha }}
- uses: actions/setup-java@v5
with:
distribution: 'temurin'
Expand All @@ -88,7 +87,7 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.workflow_run.head_sha || github.sha }}
ref: ${{ github.sha }}
- uses: actions/setup-java@v5
with:
distribution: 'temurin'
Expand Down
18 changes: 7 additions & 11 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,20 +88,16 @@ jobs:
runs-on: ubuntu-latest
needs: [resolve, tag]
steps:
- name: Dispatch docs and javadoc workflows
- name: Dispatch Maven publish
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
VERSION="${{ needs.resolve.outputs.version }}"
TAG="${{ needs.resolve.outputs.tag }}"
# Use workflow_dispatch (not the tag push) to launch docs.yml.
# This avoids GitHub's GITHUB_TOKEN-pushed-tag rule that suppresses
# downstream workflow_run events — publish-maven.yml will then see
# docs as a workflow_dispatch source and trigger correctly.
gh workflow run docs.yml --repo "$GITHUB_REPOSITORY" --ref "$TAG" \
-f version="$VERSION" \
-f alias=stable \
-f set_default=true
gh workflow run javadoc.yml --repo "$GITHUB_REPOSITORY" --ref "$TAG" \
# Documentation lives in the separate MagicUtilsWebsite (Nuxt) project,
# so the release only dispatches the Maven publish. Use workflow_dispatch
# (not the tag push) to avoid GitHub's GITHUB_TOKEN-pushed-tag rule that
# suppresses downstream workflow_run events.
gh workflow run publish-maven.yml --repo "$GITHUB_REPOSITORY" --ref "$TAG" \
-f version="$VERSION"
Comment on lines +101 to 102

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (bug_risk): The version input passed to publish-maven.yml is not defined in that workflow and will cause gh workflow run to fail.

publish-maven.yml defines only on: workflow_dispatch and no inputs. Passing -f version="$VERSION" to gh workflow run will therefore fail with "workflow does not accept input 'version'". Please either add a workflow_dispatch.inputs.version to publish-maven.yml and use it, or remove the -f version flag from this invocation.

echo "Dispatched docs.yml and javadoc.yml for $TAG"
echo "Dispatched publish-maven.yml for $TAG"
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down Expand Up @@ -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

Expand All @@ -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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The 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 RELEASING.md describes the docs site as living in a separate MagicUtilsWebsite project, the phrase "builds docs/javadoc" here is probably inaccurate. Please reword to indicate that CI tags the release and publishes artifacts (and any Javadoc jars), without suggesting the full docs site is built in this pipeline.

Loading
Loading