Skip to content

Add views property to update-project frontmatter configuration#9907

Merged
mnkiefer merged 5 commits intomainfrom
copilot/document-project-views-creation
Jan 14, 2026
Merged

Add views property to update-project frontmatter configuration#9907
mnkiefer merged 5 commits intomainfrom
copilot/document-project-views-creation

Conversation

Copy link
Contributor

Copilot AI commented Jan 14, 2026

Implements declarative project view configuration in workflow frontmatter, allowing users to define views directly in update-project safe output configuration instead of via programmatic MCP tool calls.

Changes

Go Implementation:

  • Added ProjectView struct with fields: name, layout, filter, visible_fields, description
  • Added Views []ProjectView field to UpdateProjectConfig struct
  • Implemented parsing logic in parseUpdateProjectConfig() to extract views from frontmatter YAML
  • Updated compiler to serialize views as JSON and pass via GH_AW_PROJECT_VIEWS environment variable

JSON Schema:

  • Added views array property to update-project schema in pkg/parser/schemas/main_workflow_schema.json
  • Schema validates required fields (name, layout) and optional fields (filter, visible-fields, description)
  • Supports all three layout types: table, board, roadmap

JavaScript Runtime:

  • Enhanced main() function in actions/setup/js/update_project.cjs to read and parse GH_AW_PROJECT_VIEWS
  • Automatically creates configured views after processing agent output items
  • Reuses existing view creation logic with synthetic output items

Documentation:

  • Added "Creating Project Views" section to docs/src/content/docs/reference/safe-outputs.md with configuration examples, property reference table, layout descriptions, and filter syntax
  • Updated docs/src/content/docs/reference/frontmatter-full.md with views property documentation and inline examples
  • Added "Declarative view configuration" section to docs/src/content/docs/guides/campaigns/project-management.md explaining the feature

Usage Example

safe-outputs:
  update-project:
    max: 5
    github-token: "${{ secrets.GH_AW_PROJECT_GITHUB_TOKEN }}"
    views:
      - name: "Sprint Board"
        layout: board
        filter: "is:issue is:open"
      - name: "Task Tracker"
        layout: table
        filter: "is:issue,is:pull_request"
      - name: "Timeline View"
        layout: roadmap

Views are serialized as JSON in the compiled workflow and automatically created at runtime when the workflow executes.

Files Changed

  • pkg/workflow/update_project.go - Added ProjectView struct and parsing logic
  • pkg/workflow/compiler_safe_outputs_specialized.go - Added environment variable serialization
  • pkg/workflow/update_project_job.go - Added views support for standalone job path
  • pkg/parser/schemas/main_workflow_schema.json - Added views schema definition
  • actions/setup/js/update_project.cjs - Added runtime view creation logic
  • docs/src/content/docs/reference/safe-outputs.md - Added comprehensive view creation documentation
  • docs/src/content/docs/reference/frontmatter-full.md - Added views property to update-project configuration
  • docs/src/content/docs/guides/campaigns/project-management.md - Added declarative view configuration section
Original prompt

Also document creating project views based in the work done in this PR #9797


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…nagement guides

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Document creating project views based on PR #9797 Document project view creation via update-project safe output Jan 14, 2026
Copilot AI requested a review from mnkiefer January 14, 2026 04:35
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title Document project view creation via update-project safe output Revert premature documentation of programmatic project view creation Jan 14, 2026
@mnkiefer
Copy link
Contributor

@copilot Add views property to update-project frontmatter (similar to how create-project has target-owner).

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title Revert premature documentation of programmatic project view creation Add views property to update-project frontmatter configuration Jan 14, 2026
Copilot stopped work on behalf of mnkiefer due to an error January 14, 2026 05:11
@mnkiefer
Copy link
Contributor

@copilot Document this new safe outputs feature.

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jan 14, 2026

@copilot Document this new safe outputs feature.

Documented the views property in commit 6534307.

Documentation added to:

  1. safe-outputs.md - Added comprehensive "Creating Project Views" section with:

    • Configuration examples for all layout types (table, board, roadmap)
    • Property reference table
    • Filter syntax examples
    • Cross-references to Project Management Guide
  2. frontmatter-full.md - Updated update-project configuration with views property and inline examples

  3. project-management.md - Added "Declarative view configuration" section explaining how to use the feature

The documentation explains that users can declare views in frontmatter like:

safe-outputs:
  update-project:
    views:
      - name: "Sprint Board"
        layout: board
        filter: "is:issue is:open"

Views are automatically created during workflow execution.

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:

  • telemetry.astro.build
    • Triggering command: /opt/hostedtoolcache/node/24.12.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI requested a review from mnkiefer January 14, 2026 05:19
@mnkiefer mnkiefer marked this pull request as ready for review January 14, 2026 05:19
@mnkiefer mnkiefer merged commit a77d3d1 into main Jan 14, 2026
117 checks passed
@mnkiefer mnkiefer deleted the copilot/document-project-views-creation branch January 14, 2026 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants