documentation to clarify and streamline the process for building and publishing a miner solution as a Docker image.#110
Open
abdibekbolot wants to merge 1 commit intomainfrom
Open
documentation to clarify and streamline the process for building and publishing a miner solution as a Docker image.#110abdibekbolot wants to merge 1 commit intomainfrom
abdibekbolot wants to merge 1 commit intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the miner workflow documentation to better guide users through building, verifying, and publishing a miner solution Docker image, while aligning template directory references to examples/miner_commit.
Changes:
- Reworked the “Build and Publish” workflow with environment init, build configuration guidance, local sanity checks, and clearer Docker Hub publishing steps.
- Updated “Develop Solution” docs and template links to reference
examples/miner_commitinstead oftemplates/commit.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/miner/workflow/3.build-and-publish.md | Expanded and reorganized build/publish steps; added warnings/tips and a local verification step. |
| docs/miner/workflow/2.develop-solution.md | Updated challenge template links and instructions to use examples/miner_commit. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+63
to
+80
| !!! danger "DO NOT BUILD FROM THE ROOT DIRECTORY" | ||
| Do **not** run the following command from the project root: | ||
|
|
||
| ```sh | ||
| docker build -t <USERNAME>/<REPO_NAME>:<VERSION> . | ||
| # For example: | ||
| docker build -t my_username/my_repo:1.0.0 . | ||
| ```bash | ||
| docker build . | ||
| ``` | ||
|
|
||
| !!! danger "IMPORTANT" | ||
| To prevent submission theft, please don't include the challenge name or your Discord username in the image name. This precaution is necessary because multiple miners can locate your image on Docker Hub and submit it on your behalf. | ||
| This will either fail or build the wrong image. | ||
|
|
||
| ## 3.2. Publish docker image | ||
| Always build through **Docker Compose**, which ensures the correct build context: | ||
|
|
||
| ### 3.2.1. Create Docker Hub account | ||
| ``` | ||
| cd ./examples/miner_commit | ||
| ``` | ||
|
|
||
| ```bash | ||
| docker compose build miner-commit-api | ||
| ``` |
Comment on lines
+49
to
+52
| docker ps -a | ||
| ~~~ | ||
|
|
||
| You should see two containers: |
Comment on lines
+54
to
+56
| - **Auto Browser Sniffer Challenge**: <https://github.com/RedTeamSubnet/ab-sniffer-challenge/tree/main/examples/miner_commit> | ||
| - **Anti-Detect Automation Challenge**: <https://github.com/RedTeamSubnet/ada-detection-challenge/tree/main/examples/miner_commit> | ||
| - **Humanize Behavior Challenge**: <https://github.com/RedTeamSubnet/humanize-behaviour-challenge/tree/main/examples/miner_commit> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates and expands the miner workflow documentation to clarify and streamline the process for building and publishing a miner solution as a Docker image. The documentation now provides step-by-step instructions for initializing the environment, configuring and building the Docker image, verifying the image locally, and publishing it securely to Docker Hub. It also introduces new warnings and tips to help prevent common mistakes, such as building from the wrong directory or exposing sensitive information.
Key documentation improvements:
Clarification and correction of directory structure:
templates/committoexamples/miner_commitfor both challenge templates and solution development paths, ensuring consistency and accuracy in instructions.Expanded and reorganized build and publish workflow:
Security and submission best practices:
Improved instructions for Docker Hub publishing: