Conversation
Ref: https://github.com/Dans-Plugins/dpc-conventions Co-authored-by: dmccoystephenson <21204351+dmccoystephenson@users.noreply.github.com> Agent-Logs-Url: https://github.com/Dans-Plugins/Nether-Access-Controller/sessions/d06b5d6f-3f34-4ebd-8c29-4d833bcdb02c
There was a problem hiding this comment.
Pull request overview
Aligns the repository with Dans Plugins Community (DPC) conventions by adding/standardizing documentation and introducing baseline CI/CD workflows for Maven-based builds and releases.
Changes:
- Restructures and updates
README.mdto match DPC-required section ordering and point to in-repo documentation. - Adds new documentation files: contributing guide, user guide, commands reference, configuration guide, and changelog.
- Adds GitHub Actions workflows for PR/push builds and release asset attachment, plus a Copilot instructions file.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
README.md |
Reorders sections per DPC conventions; updates links and adds build/testing guidance. |
USER_GUIDE.md |
Adds end-user setup guidance, common workflows, and a permissions table. |
CONTRIBUTING.md |
Documents contribution workflow and Maven build/manual testing steps. |
COMMANDS.md |
Documents /nac subcommands, permissions, usage, and examples. |
CONFIG.md |
Documents config options, defaults, and examples. |
CHANGELOG.md |
Adds Keep a Changelog–style changelog with initial entries. |
.github/workflows/build.yml |
Adds CI build on push/PR to main/develop using Maven. |
.github/workflows/release.yml |
Builds and uploads target/*.jar artifacts to GitHub Releases. |
.github/copilot-instructions.md |
Adds repo/stack/conventions guidance for Copilot contributions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Permission | Default | Description | | ||
| |------------|---------|-------------| | ||
| | `nac.help` | op | Access the help command | | ||
| | `nac.list` | op | View the nether access whitelist | | ||
| | `nac.allow` | op | Allow a player nether access | | ||
| | `nac.deny` | op | Deny a player nether access | | ||
| | `nac.config` | op | View and modify configuration | |
There was a problem hiding this comment.
The permissions table syntax has an extra leading | on each row (e.g., || Permission | ...), which renders as an unintended empty first column in most Markdown renderers. Use standard table rows starting with a single | for consistent rendering.
| | `nac.help` | op | Access the help command | | ||
| | `nac.list` | op | View the nether access whitelist | | ||
| | `nac.allow` | op | Allow a player nether access | | ||
| | `nac.deny` | op | Deny a player nether access | | ||
| | `nac.config` | op | View and modify configuration | |
There was a problem hiding this comment.
This guide documents permissions as nac.*, but src/main/resources/plugin.yml currently declares wac.* permissions (and only defines defaults for those). Either update the docs to match the declared permission nodes or update plugin.yml in a follow-up so default permission behavior matches what the plugin checks at runtime.
| | `nac.help` | op | Access the help command | | |
| | `nac.list` | op | View the nether access whitelist | | |
| | `nac.allow` | op | Allow a player nether access | | |
| | `nac.deny` | op | Deny a player nether access | | |
| | `nac.config` | op | View and modify configuration | | |
| | `wac.help` | op | Access the help command | | |
| | `wac.list` | op | View the nether access whitelist | | |
| | `wac.allow` | op | Allow a player nether access | | |
| | `wac.deny` | op | Deny a player nether access | | |
| | `wac.config` | op | View and modify configuration | |
|
|
||
| **Description:** Lists all available commands. | ||
| **Permission:** `nac.help` | ||
| **Usage:** `/nac help` |
There was a problem hiding this comment.
The permissions referenced here are nac.*, but src/main/resources/plugin.yml currently declares wac.* permission nodes. This mismatch can cause confusing default permission behavior; align the documented permission nodes with what the plugin actually defines/enforces.
| | Name | Main Contributions | | ||
| |------|--------------------| | ||
| | Daniel Stephenson | Creator | |
There was a problem hiding this comment.
The authors table rows start with ||, which produces an extra empty column in Markdown and may not render as intended. Use a single leading | per row (and adjust the separator row accordingly).
.github/copilot-instructions.md
Outdated
|
|
||
| - `src/main/java/` – Plugin source code | ||
| - `src/main/resources/` – `plugin.yml` and resource files | ||
| - `src/test/java/` – Unit tests |
There was a problem hiding this comment.
This file states that unit tests live in src/test/java/, but the repository currently only has src/main/ (no src/test/). Please update the project structure section to reflect the current repo layout (or add the test directory if intended).
| - `src/test/java/` – Unit tests | |
| - `src/test/java/` – (Optional) Unit tests (create this directory as needed) |
.github/workflows/release.yml
Outdated
| - name: Upload JAR to release | ||
| uses: softprops/action-gh-release@v2 | ||
| with: | ||
| files: target/*.jar |
There was a problem hiding this comment.
files: target/*.jar will likely upload both the shaded artifact and the original-*.jar produced by maven-shade-plugin, which can confuse releases. Consider uploading only the intended final jar (e.g., exclude original-*.jar or configure shade to not keep the original).
| files: target/*.jar | |
| files: | | |
| target/*.jar | |
| !target/original-*.jar |
|
@copilot address comments |
…release glob Co-authored-by: dmccoystephenson <21204351+dmccoystephenson@users.noreply.github.com> Agent-Logs-Url: https://github.com/Dans-Plugins/Nether-Access-Controller/sessions/c71c250a-a4a6-4b4f-bd43-f6bdbac52fa7
All review comments addressed in 6a2b151:
|
|
@copilot change all permissions to NAC not wac |
Co-authored-by: dmccoystephenson <21204351+dmccoystephenson@users.noreply.github.com> Agent-Logs-Url: https://github.com/Dans-Plugins/Nether-Access-Controller/sessions/73794ca4-33bc-4324-8a80-9bd715079832
Changed all permission nodes to Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 10 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Adds all missing documentation and CI/CD files required by the DPC conventions.
README.md
dmccoystephenson/→Dans-Plugins/New documentation files
/nacsubcommands with syntax, permissions, examplesCI/CD workflows
.github/workflows/build.yml— Builds on push/PR tomainanddevelop; explicitpermissions: contents: read.github/workflows/release.yml— Builds and attachestarget/*.jaron release creation; excludesoriginal-*.jarBoth workflows use Maven (
mvn clean package) since the project usespom.xml, not Gradle.Copilot instructions
.github/copilot-instructions.md— Technology stack, project structure, coding conventions, contribution workflowPermission node fix
plugin.ymlto declarenac.*permission nodes instead of the incorrectwac.*, aligning with what the Java source (CommandService.java) actually checks at runtimenac.*permission nodes📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.