diff --git a/.github/workflows/gh-aw-docs-issue-scope.lock.yml b/.github/workflows/gh-aw-docs-issue-scope.lock.yml index 8117e66..b1c896e 100644 --- a/.github/workflows/gh-aw-docs-issue-scope.lock.yml +++ b/.github/workflows/gh-aw-docs-issue-scope.lock.yml @@ -1,4 +1,4 @@ -# gh-aw-metadata: {"schema_version":"v3","frontmatter_hash":"c6110bfb441cdcfcfe933cc4387a974c84b62b9ff9ab3095093f7447df98e0cf","compiler_version":"v0.68.1","agent_id":"copilot"} +# gh-aw-metadata: {"schema_version":"v3","frontmatter_hash":"e07dc4a695adf199f069f176175b64a03cf86b1258c863b1e714ee41a681488d","compiler_version":"v0.68.1","agent_id":"copilot"} # gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/checkout","sha":"de0fac2e4500dabe0009e67214ff5f5447ce83dd","version":"v6.0.2"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9"},{"repo":"actions/upload-artifact","sha":"bbbca2ddaa5d8feaa63e36b76fdaad77386f024f","version":"v7"},{"repo":"github/gh-aw-actions/setup","sha":"2fe53acc038ba01c3bbdc767d4b25df31ca5bdfc","version":"v0.68.1"}]} # ___ _ _ # / _ \ | | (_) @@ -202,14 +202,14 @@ jobs: run: | bash "${RUNNER_TEMP}/gh-aw/actions/create_prompt_first.sh" { - cat << 'GH_AW_PROMPT_f890a03852a57d38_EOF' + cat << 'GH_AW_PROMPT_70c157fbc8a3b6b6_EOF' - GH_AW_PROMPT_f890a03852a57d38_EOF + GH_AW_PROMPT_70c157fbc8a3b6b6_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/safe_outputs_prompt.md" - cat << 'GH_AW_PROMPT_f890a03852a57d38_EOF' + cat << 'GH_AW_PROMPT_70c157fbc8a3b6b6_EOF' Tools: add_comment, update_issue, missing_tool, missing_data, noop @@ -241,9 +241,9 @@ jobs: {{/if}} - GH_AW_PROMPT_f890a03852a57d38_EOF + GH_AW_PROMPT_70c157fbc8a3b6b6_EOF cat "${RUNNER_TEMP}/gh-aw/prompts/github_mcp_tools_with_safeoutputs_prompt.md" - cat << 'GH_AW_PROMPT_f890a03852a57d38_EOF' + cat << 'GH_AW_PROMPT_70c157fbc8a3b6b6_EOF' ## Formatting Guidelines @@ -430,10 +430,13 @@ jobs: Use this exact body-block format inside the managed markers: ``` - ## Docs issue scope - + ## AI scoping 🤖 + +
+ Docs issue scope + ### Summary <1 short paragraph separating what the issue asks for from what the linked code changes show.> @@ -465,6 +468,8 @@ jobs: +
+ ``` @@ -482,10 +487,13 @@ jobs: If the request does not have enough information, use this shorter managed block for issue-body updates: ``` - ## Docs issue scope - + ## AI scoping 🤖 + +
+ Docs issue scope + ### Next action for author Add more issue detail or link the relevant public PRs or commits, then rerun `/docs-issue-scope`. @@ -496,6 +504,8 @@ jobs: 1. 2. +
+ ``` @@ -511,7 +521,7 @@ jobs: __GH_AW_EXPR_49B959F1__ - GH_AW_PROMPT_f890a03852a57d38_EOF + GH_AW_PROMPT_70c157fbc8a3b6b6_EOF } > "$GH_AW_PROMPT" - name: Interpolate variables and render templates uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9 @@ -686,9 +696,9 @@ 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_7e472cabf7fa3a79_EOF' + cat > "${RUNNER_TEMP}/gh-aw/safeoutputs/config.json" << 'GH_AW_SAFE_OUTPUTS_CONFIG_76ae2fe32268bf16_EOF' {"add_comment":{"hide_older_comments":true,"max":1},"create_report_incomplete_issue":{},"missing_data":{},"missing_tool":{},"noop":{"max":1,"report-as-issue":"true"},"report_incomplete":{},"update_issue":{"allow_body":true,"max":1}} - GH_AW_SAFE_OUTPUTS_CONFIG_7e472cabf7fa3a79_EOF + GH_AW_SAFE_OUTPUTS_CONFIG_76ae2fe32268bf16_EOF - name: Write Safe Outputs Tools env: GH_AW_TOOLS_META_JSON: | @@ -921,7 +931,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.17' mkdir -p /home/runner/.copilot - cat << GH_AW_MCP_CONFIG_2c38098df03b726b_EOF | bash "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.sh" + cat << GH_AW_MCP_CONFIG_f8a1718193abdb02_EOF | bash "${RUNNER_TEMP}/gh-aw/actions/start_mcp_gateway.sh" { "mcpServers": { "elastic-docs": { @@ -982,7 +992,7 @@ jobs: "payloadDir": "${MCP_GATEWAY_PAYLOAD_DIR}" } } - GH_AW_MCP_CONFIG_2c38098df03b726b_EOF + GH_AW_MCP_CONFIG_f8a1718193abdb02_EOF - name: Download activation artifact uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 with: diff --git a/.github/workflows/gh-aw-docs-issue-scope.md b/.github/workflows/gh-aw-docs-issue-scope.md index e41af4c..9aa1edd 100644 --- a/.github/workflows/gh-aw-docs-issue-scope.md +++ b/.github/workflows/gh-aw-docs-issue-scope.md @@ -216,10 +216,13 @@ Prefer `update_issue` as the primary output when the triggering item is an issue Use this exact body-block format inside the managed markers: ``` -## Docs issue scope - +## AI scoping 🤖 + +
+Docs issue scope + ### Summary <1 short paragraph separating what the issue asks for from what the linked code changes show.> @@ -251,6 +254,8 @@ Use this exact body-block format inside the managed markers: +
+ ``` @@ -268,10 +273,13 @@ When you do need `add_comment`, keep it brief and point the reader to the issue If the request does not have enough information, use this shorter managed block for issue-body updates: ``` -## Docs issue scope - +## AI scoping 🤖 + +
+Docs issue scope + ### Next action for author Add more issue detail or link the relevant public PRs or commits, then rerun `/docs-issue-scope`. @@ -282,6 +290,8 @@ Add more issue detail or link the relevant public PRs or commits, then rerun `/d 1. 2. +
+ ``` diff --git a/agentic-workflows/docs-issue-scope/README.md b/agentic-workflows/docs-issue-scope/README.md index 00f8ecf..8d61ed6 100644 --- a/agentic-workflows/docs-issue-scope/README.md +++ b/agentic-workflows/docs-issue-scope/README.md @@ -1,6 +1,6 @@ # Docs Issue Scope -Uses an issue description plus linked public PRs and commits to scope Elastic documentation work. When the command runs on an issue, it maintains a concise bot-managed scope block in the issue body when that can be done safely. Otherwise, it falls back to a concise comment with recommended doc targets and next steps. +Uses an issue description plus linked public PRs and commits to scope Elastic documentation work. When the command runs on an issue, it maintains a concise bot-managed scope block in the issue body when that can be done safely. The managed block is published under an `AI scoping 🤖` heading, and the details are wrapped in a collapsible section to keep the issue body compact. Otherwise, it falls back to a concise comment with recommended doc targets and next steps. ## Triggers @@ -45,7 +45,7 @@ When `/docs-issue-scope` runs on an issue, the workflow prefers to maintain a bo - `` - `` -If the markers already exist exactly once, the workflow rewrites only that block. If the markers are missing, it appends a new block. If the markers are malformed or duplicated, it does not overwrite the issue body and falls back to a concise comment instead. +If the markers already exist exactly once, the workflow rewrites only that block. If the markers are missing, it appends a new block. The managed block includes an `AI scoping 🤖` heading followed by a GitHub `
` section. If the markers are malformed or duplicated, it does not overwrite the issue body and falls back to a concise comment instead. ## Example