Initial Minecraft Renew Mod workspace
This commit is contained in:
39
docs/agent-handoff.md
Normal file
39
docs/agent-handoff.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# Agent Handoff
|
||||
|
||||
Use this file when a task spans multiple sessions, has unresolved follow-up work, or changes release behavior.
|
||||
|
||||
## Current State
|
||||
|
||||
```text
|
||||
Codex repository kit baseline has been applied to the workspace.
|
||||
```
|
||||
|
||||
## Changes Made
|
||||
|
||||
- Added Codex agent context files.
|
||||
- Added security, contribution, changelog, and release documentation.
|
||||
- Added Gitea workflow templates adapted for the Gradle Minecraft mod workspace.
|
||||
- Added `.gitignore` entries for local kit checkout, build output, Minecraft run data, logs, and secrets.
|
||||
|
||||
## Verification
|
||||
|
||||
| Check | Result |
|
||||
| --- | --- |
|
||||
| `git diff --check` | Skipped: root workspace is not a Git repository in this environment |
|
||||
| `.\gradlew build` | Passed on 2026-05-15 |
|
||||
| `.\gradlew dependencies --configuration runtimeClasspath` | Passed on 2026-05-15 |
|
||||
|
||||
## Open Questions
|
||||
|
||||
- Decide whether release artifacts should be published only as workflow artifacts or also to the Gitea Package Registry.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- Run `.\gradlew build` from `create-limited-draining/`.
|
||||
- Run manual Hose Pulley gameplay tests before publishing.
|
||||
- Update this handoff file if release or CI behavior changes.
|
||||
|
||||
## Risks
|
||||
|
||||
- The root workspace is currently not detected as a Git repository in this environment.
|
||||
- The port is documented as minimally verified; behavior still needs manual in-game testing.
|
||||
37
docs/release-checklist.md
Normal file
37
docs/release-checklist.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Release Checklist
|
||||
|
||||
## Version
|
||||
|
||||
- [ ] Version number updated in `create-limited-draining/gradle.properties`.
|
||||
- [ ] Changelog updated.
|
||||
- [ ] README updated if build, config, or release behavior changed.
|
||||
|
||||
## Quality
|
||||
|
||||
- [ ] Working tree is clean.
|
||||
- [ ] `.\gradlew build` passes from `create-limited-draining/`.
|
||||
- [ ] Tests pass or missing tests are documented.
|
||||
- [ ] Client smoke test completed when behavior changes affect gameplay.
|
||||
- [ ] Server smoke test completed when behavior changes affect server behavior.
|
||||
- [ ] CI build succeeds if Gitea Actions are enabled.
|
||||
|
||||
## Security
|
||||
|
||||
- [ ] Security review is current.
|
||||
- [ ] Dependency review is clean or documented.
|
||||
- [ ] No secrets are committed.
|
||||
- [ ] Release artifact does not contain local config, worlds, logs, or generated run data.
|
||||
|
||||
## Artifacts
|
||||
|
||||
- [ ] JAR exists under `create-limited-draining/build/libs/`.
|
||||
- [ ] Artifact filename and version are clear.
|
||||
- [ ] Download links work if a release or package is published.
|
||||
- [ ] Package registry links work if used.
|
||||
|
||||
## Release
|
||||
|
||||
- [ ] Git tag created after approval.
|
||||
- [ ] Release notes written.
|
||||
- [ ] Release published after approval.
|
||||
- [ ] Post-release download smoke test completed.
|
||||
32
docs/release-notes.md
Normal file
32
docs/release-notes.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Minecraft Renew Mod Unreleased
|
||||
|
||||
## Downloads
|
||||
|
||||
| Variant | Download |
|
||||
| --- | --- |
|
||||
| Mod JAR | PENDING |
|
||||
|
||||
## Highlights
|
||||
|
||||
- NeoForge port workspace for Create: Limited Draining.
|
||||
- Targeted at Minecraft 1.21.1, NeoForge 21.1.228, and Create 6.0.10.
|
||||
- Adds configurable fluid and biome rules for Create Hose Pulley infinite draining.
|
||||
|
||||
## Security
|
||||
|
||||
- Dependency review: Gradle `runtimeClasspath` report completed on 2026-05-15
|
||||
- Secret handling: local secrets, run data, logs, and build outputs are ignored
|
||||
- External network calls: Gradle dependency repositories only
|
||||
|
||||
## Verification
|
||||
|
||||
| Check | Result |
|
||||
| --- | --- |
|
||||
| `.\gradlew build` | Passed on 2026-05-15 |
|
||||
| Client smoke test | PENDING |
|
||||
| Server smoke test | PENDING |
|
||||
| Artifact download | PENDING |
|
||||
|
||||
## Notes
|
||||
|
||||
Do not publish a release until manual in-game Hose Pulley behavior has been verified.
|
||||
55
docs/security-review.md
Normal file
55
docs/security-review.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# Security Review
|
||||
|
||||
## Scope
|
||||
|
||||
Project:
|
||||
|
||||
```text
|
||||
minecraft-renew-mod / create-limited-draining
|
||||
```
|
||||
|
||||
Reviewed version or commit:
|
||||
|
||||
```text
|
||||
Unreleased workspace state
|
||||
```
|
||||
|
||||
## Code Patterns Checked
|
||||
|
||||
- [ ] No `eval`.
|
||||
- [ ] No dynamic `Function` constructor.
|
||||
- [ ] No unsafe HTML injection.
|
||||
- [ ] No unexpected shell execution.
|
||||
- [ ] No unexpected external network calls.
|
||||
- [ ] No secrets committed.
|
||||
- [ ] No unsafe file writes outside expected Gradle/Minecraft runtime paths.
|
||||
|
||||
## Dependency Review
|
||||
|
||||
Command:
|
||||
|
||||
```powershell
|
||||
cd create-limited-draining
|
||||
.\gradlew dependencies --configuration runtimeClasspath
|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||
```text
|
||||
Completed successfully on 2026-05-15. Gradle resolved runtimeClasspath and reported the expected NeoForge, Create, Ponder, Flywheel, and Registrate dependency tree.
|
||||
```
|
||||
|
||||
## Runtime Review
|
||||
|
||||
- [ ] Least-privilege runtime configuration.
|
||||
- [ ] External dependency repositories documented in Gradle.
|
||||
- [ ] Local Minecraft run data is ignored.
|
||||
- [ ] Sensitive data is not persisted unless explicitly required.
|
||||
|
||||
## Release Notes
|
||||
|
||||
Known residual risks:
|
||||
|
||||
```text
|
||||
In-game Hose Pulley behavior still needs manual world testing before publication.
|
||||
```
|
||||
Reference in New Issue
Block a user