diff --git a/.github/workflows/docs-noob-tester.lock.yml b/.github/workflows/docs-noob-tester.lock.yml index c42a174e85..d9672224da 100644 --- a/.github/workflows/docs-noob-tester.lock.yml +++ b/.github/workflows/docs-noob-tester.lock.yml @@ -25,9 +25,10 @@ # Resolved workflow manifest: # Imports: # - shared/docs-server-lifecycle.md +# - shared/keep-it-short.md # - shared/reporting.md # -# gh-aw-metadata: {"schema_version":"v3","frontmatter_hash":"a0d758758d887feb9fb3640afc084de2ecde2307eaab185ccb3a94c7486665b4","strict":true,"agent_id":"copilot"} +# gh-aw-metadata: {"schema_version":"v3","frontmatter_hash":"f48738a1d508a3ad6137477f60c5190ea1e0c14fce2a0d43af26b1fc7eac51a1","strict":true,"agent_id":"copilot"} name: "Documentation Noob Tester" "on": @@ -132,15 +133,15 @@ jobs: run: | bash ${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh { - cat << 'GH_AW_PROMPT_a97e46f4b5fb2321_EOF' + cat << 'GH_AW_PROMPT_e4aea7ebb63f4120_EOF' - GH_AW_PROMPT_a97e46f4b5fb2321_EOF + GH_AW_PROMPT_e4aea7ebb63f4120_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/xpia.md" cat "${RUNNER_TEMP}/gh-aw/prompts/temp_folder_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/markdown.md" cat "${RUNNER_TEMP}/gh-aw/prompts/playwright_prompt.md" cat "${RUNNER_TEMP}/gh-aw/prompts/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_a97e46f4b5fb2321_EOF' + cat << 'GH_AW_PROMPT_e4aea7ebb63f4120_EOF' Tools: create_discussion, upload_asset, missing_tool, missing_data, noop @@ -174,14 +175,15 @@ jobs: {{/if}} - GH_AW_PROMPT_a97e46f4b5fb2321_EOF + GH_AW_PROMPT_e4aea7ebb63f4120_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_a97e46f4b5fb2321_EOF' + cat << 'GH_AW_PROMPT_e4aea7ebb63f4120_EOF' {{#runtime-import .github/workflows/shared/docs-server-lifecycle.md}} {{#runtime-import .github/workflows/shared/reporting.md}} + {{#runtime-import .github/workflows/shared/keep-it-short.md}} {{#runtime-import .github/workflows/docs-noob-tester.md}} - GH_AW_PROMPT_a97e46f4b5fb2321_EOF + GH_AW_PROMPT_e4aea7ebb63f4120_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8 @@ -352,12 +354,12 @@ jobs: mkdir -p ${RUNNER_TEMP}/gh-aw/safeoutputs mkdir -p /tmp/gh-aw/safeoutputs mkdir -p /tmp/gh-aw/mcp-logs/safeoutputs - cat > ${RUNNER_TEMP}/gh-aw/safeoutputs/config.json << 'GH_AW_SAFE_OUTPUTS_CONFIG_a66d2f86b72716b0_EOF' + cat > ${RUNNER_TEMP}/gh-aw/safeoutputs/config.json << 'GH_AW_SAFE_OUTPUTS_CONFIG_af85eef6e59720d9_EOF' {"create_discussion":{"category":"audits","close_older_discussions":true,"expires":24,"fallback_to_issue":true,"max":1},"missing_data":{},"missing_tool":{},"noop":{"max":1,"report-as-issue":"true"},"upload_asset":{"allowed-exts":[".png",".jpg",".jpeg"],"branch":"assets/${{ github.workflow }}","max-size":10240}} - GH_AW_SAFE_OUTPUTS_CONFIG_a66d2f86b72716b0_EOF + GH_AW_SAFE_OUTPUTS_CONFIG_af85eef6e59720d9_EOF - name: Write Safe Outputs Tools run: | - cat > ${RUNNER_TEMP}/gh-aw/safeoutputs/tools_meta.json << 'GH_AW_SAFE_OUTPUTS_TOOLS_META_0eab119a93e90dc3_EOF' + cat > ${RUNNER_TEMP}/gh-aw/safeoutputs/tools_meta.json << 'GH_AW_SAFE_OUTPUTS_TOOLS_META_c709493d8205c28a_EOF' { "description_suffixes": { "create_discussion": " CONSTRAINTS: Maximum 1 discussion(s) can be created. Discussions will be created in category \"audits\".", @@ -366,8 +368,8 @@ jobs: "repo_params": {}, "dynamic_tools": [] } - GH_AW_SAFE_OUTPUTS_TOOLS_META_0eab119a93e90dc3_EOF - cat > ${RUNNER_TEMP}/gh-aw/safeoutputs/validation.json << 'GH_AW_SAFE_OUTPUTS_VALIDATION_be9f713b2a2b26d5_EOF' + GH_AW_SAFE_OUTPUTS_TOOLS_META_c709493d8205c28a_EOF + cat > ${RUNNER_TEMP}/gh-aw/safeoutputs/validation.json << 'GH_AW_SAFE_OUTPUTS_VALIDATION_618622091275873e_EOF' { "create_discussion": { "defaultMax": 1, @@ -462,7 +464,7 @@ jobs: } } } - GH_AW_SAFE_OUTPUTS_VALIDATION_be9f713b2a2b26d5_EOF + GH_AW_SAFE_OUTPUTS_VALIDATION_618622091275873e_EOF node ${RUNNER_TEMP}/gh-aw/actions/generate_safe_outputs_tools.cjs - name: Generate Safe Outputs MCP Server Config id: safe-outputs-config @@ -534,7 +536,7 @@ jobs: export MCP_GATEWAY_DOCKER_COMMAND='docker run -i --rm --network host -v /var/run/docker.sock:/var/run/docker.sock -e MCP_GATEWAY_PORT -e MCP_GATEWAY_DOMAIN -e MCP_GATEWAY_API_KEY -e MCP_GATEWAY_PAYLOAD_DIR -e MCP_GATEWAY_PAYLOAD_SIZE_THRESHOLD -e DEBUG -e MCP_GATEWAY_LOG_DIR -e GH_AW_MCP_LOG_DIR -e GH_AW_SAFE_OUTPUTS -e GH_AW_SAFE_OUTPUTS_CONFIG_PATH -e GH_AW_SAFE_OUTPUTS_TOOLS_PATH -e GH_AW_ASSETS_BRANCH -e GH_AW_ASSETS_MAX_SIZE_KB -e GH_AW_ASSETS_ALLOWED_EXTS -e DEFAULT_BRANCH -e GITHUB_MCP_SERVER_TOKEN -e GITHUB_MCP_GUARD_MIN_INTEGRITY -e GITHUB_MCP_GUARD_REPOS -e GITHUB_REPOSITORY -e GITHUB_SERVER_URL -e GITHUB_SHA -e GITHUB_WORKSPACE -e GITHUB_TOKEN -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RUN_ATTEMPT -e GITHUB_JOB -e GITHUB_ACTION -e GITHUB_EVENT_NAME -e GITHUB_EVENT_PATH -e GITHUB_ACTOR -e GITHUB_ACTOR_ID -e GITHUB_TRIGGERING_ACTOR -e GITHUB_WORKFLOW -e GITHUB_WORKFLOW_REF -e GITHUB_WORKFLOW_SHA -e GITHUB_REF -e GITHUB_REF_NAME -e GITHUB_REF_TYPE -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GH_AW_SAFE_OUTPUTS_PORT -e GH_AW_SAFE_OUTPUTS_API_KEY -v /tmp/gh-aw/mcp-payloads:/tmp/gh-aw/mcp-payloads:rw -v /opt:/opt:ro -v /tmp:/tmp:rw -v '"${GITHUB_WORKSPACE}"':'"${GITHUB_WORKSPACE}"':rw ghcr.io/github/gh-aw-mcpg:v0.2.10' mkdir -p /home/runner/.copilot - cat << GH_AW_MCP_CONFIG_7d46f4fc900e3428_EOF | bash ${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.sh + cat << GH_AW_MCP_CONFIG_f999db1d830d3ecb_EOF | bash ${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.sh { "mcpServers": { "github": { @@ -589,7 +591,7 @@ jobs: "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}" } } - GH_AW_MCP_CONFIG_7d46f4fc900e3428_EOF + GH_AW_MCP_CONFIG_f999db1d830d3ecb_EOF - name: Download activation artifact uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 with: @@ -601,7 +603,7 @@ jobs: - name: Execute GitHub Copilot CLI id: agentic_execution # Copilot CLI tool arguments (sorted): - timeout-minutes: 30 + timeout-minutes: 45 run: | set -o pipefail touch /tmp/gh-aw/agent-step-summary.md @@ -888,7 +890,7 @@ jobs: GH_AW_LOCKDOWN_CHECK_FAILED: ${{ needs.activation.outputs.lockdown_check_failed }} GH_AW_GROUP_REPORTS: "false" GH_AW_FAILURE_REPORT_AS_ISSUE: "true" - GH_AW_TIMEOUT_MINUTES: "30" + GH_AW_TIMEOUT_MINUTES: "45" with: github-token: ${{ secrets.GH_AW_GITHUB_TOKEN || secrets.GITHUB_TOKEN }} script: | diff --git a/.github/workflows/docs-noob-tester.md b/.github/workflows/docs-noob-tester.md index 6f4b54f331..8a51c7153f 100644 --- a/.github/workflows/docs-noob-tester.md +++ b/.github/workflows/docs-noob-tester.md @@ -9,7 +9,7 @@ permissions: issues: read pull-requests: read engine: copilot -timeout-minutes: 30 +timeout-minutes: 45 runtimes: node: version: "22" @@ -34,6 +34,7 @@ network: imports: - shared/docs-server-lifecycle.md - shared/reporting.md + - shared/keep-it-short.md features: copilot-requests: true --- @@ -54,12 +55,11 @@ Act as a complete beginner who has never used GitHub Agentic Workflows before. B ## Step 1: Build and Serve Documentation Site -Navigate to the docs folder and build the documentation site using the steps from docs.yml: +Navigate to the docs folder and start the documentation site: ```bash cd ${{ github.workspace }}/docs npm install -npm run build ``` Follow the shared **Documentation Server Lifecycle Management** instructions: @@ -114,7 +114,7 @@ mcp__playwright__browser_run_code({ }) ``` -Using Playwright, navigate through the documentation site as if you're a complete beginner: +Using Playwright, visit exactly these 3 pages and stop: 1. **Visit the home page** at `http://${SERVER_IP}:4321/gh-aw/` - Take a screenshot @@ -136,15 +136,7 @@ Using Playwright, navigate through the documentation site as if you're a complet - Note: Are the most important commands highlighted? - Note: Are examples provided for common use cases? -4. **Explore Creating Workflows guide** at `http://${SERVER_IP}:4321/gh-aw/setup/creating-workflows/` - - Take screenshots of confusing sections - - Note: Is the workflow format explained clearly? - - Note: Are there enough examples? - -5. **Browse Examples section** - - Visit at least 2-3 example pages - - Take screenshots if explanations are unclear - - Note: Can you understand how to adapt examples to your own use case? +After visiting all 3 pages, immediately proceed to the report. ## Step 3: Identify Pain Points @@ -223,7 +215,7 @@ Follow the shared **Documentation Server Lifecycle Management** instructions for ## Success Criteria You've successfully completed this task if you: -- Navigated at least 5 key documentation pages +- Navigated exactly 3 key documentation pages - Identified specific pain points with examples - Provided actionable recommendations - Created a discussion with clear findings and screenshots