fix: correct gws docs +write flags in recipe-post-mortem-setup#757
fix: correct gws docs +write flags in recipe-post-mortem-setup#757xiaolai wants to merge 1 commit intogoogleworkspace:mainfrom
Conversation
The +write subcommand requires --document <ID> and --text <TEXT>. The --title and --body flags do not exist. Add a preceding step to create the document via `gws docs documents create` and capture the returned documentId before writing the template content. Co-Authored-By: Claude Code <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: 672af15 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a functional bug in the recipe-post-mortem-setup skill where incorrect CLI flags were causing the workflow to fail. By restructuring the document creation process and updating the command syntax, the post-mortem setup is now correctly aligned with the expected gws CLI behavior. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the post-mortem setup skill documentation to correctly reflect the two-step process of creating a Google Doc and then writing content to it, fixing the use of incorrect flags. A review comment points out that the document creation command should use the --json flag instead of --params to ensure the document title is correctly passed in the request body.
| 1. Create post-mortem doc: `gws docs +write --title 'Post-Mortem: [Incident]' --body '## Summary\n\n## Timeline\n\n## Root Cause\n\n## Action Items'` | ||
| 2. Schedule review meeting: `gws calendar +insert --summary 'Post-Mortem Review: [Incident]' --attendee team@company.com --start '2026-03-16T14:00:00' --end '2026-03-16T15:00:00'` | ||
| 3. Notify in Chat: `gws chat +send --space spaces/ENG_SPACE --text '🔍 Post-mortem scheduled for [Incident].'` | ||
| 1. Create post-mortem doc: `gws docs documents create --params '{"title": "Post-Mortem: [Incident]"}'` (note the returned `documentId`) |
There was a problem hiding this comment.
The gws docs documents create command should use the --json flag instead of --params for the document title. In the Google Docs API, the title is a property of the Document resource passed in the request body, not a URL parameter. Using --params will likely result in the title being ignored or the command failing.
| 1. Create post-mortem doc: `gws docs documents create --params '{"title": "Post-Mortem: [Incident]"}'` (note the returned `documentId`) | |
| 1. Create post-mortem doc: `gws docs documents create --json '{"title": "Post-Mortem: [Incident]"}'` (note the returned `documentId`) |
2 participants
The
recipe-post-mortem-setupskill contains an invalidgws docs +writeinvocation. The flags--titleand--bodydo not exist on the+writesubcommand. The correct flags are--document <ID>and--text <TEXT>. Additionally, the document must be created first (viagws docs documents create) to obtain adocumentIdbefore any content can be written to it. Without this fix, the recipe fails at step 1 with an unrecognized flag error, making the entire post-mortem workflow non-functional.The fix splits the original step 1 into two steps: first create the document and capture the returned
documentId, then write the template content using the correct flags.