Skip to content

[COMMS-887] Observed in versions API + Details/List view - #24911

Open
brunopagno wants to merge 18 commits into
devfrom
blp/impl/comms-887-observed-in-versions-api
Open

[COMMS-887] Observed in versions API + Details/List view#24911
brunopagno wants to merge 18 commits into
devfrom
blp/impl/comms-887-observed-in-versions-api

Conversation

@brunopagno

@brunopagno brunopagno commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Ticket

https://community.openproject.org/projects/FND/work_packages/COMMS-887/activity
+
https://community.openproject.org/projects/FND/work_packages/COMMS-964/activity

What are you trying to accomplish?

Include the observed_in_versions field on the work_package API

What approach did you choose and why?

  • Include the observed_in_versions field on the WorkPackage API
  • Include the observed_in_versions field on the WorkPackage Schema API
  • Exclude it from forms by default
  • Adjust display on work package form and list view
  • Adjust PDF exports to include the observed_in_version field

Merge checklist

  • Added/updated tests
  • Added/updated documentation in Lookbook (patterns, previews, etc)
  • Tested major browsers (Chrome, Firefox, Edge, ...)

@brunopagno brunopagno self-assigned this Aug 24, 2026
@github-actions

Copy link
Copy Markdown

Warning

Flaky specs

  • rspec ./spec/features/work_packages/table/switch_types_spec.rb[1:1:1]
  • rspec ./spec/features/work_packages/table/switch_types_spec.rb[1:1:2]
🤖 Ask Copilot to investigate

Copy the prompt below into a new comment on this PR to delegate the investigation to GitHub Copilot. It will look into the flakiness and open a separate pull request with you as reviewer.

@copilot The following spec(s) are flaky in CI (first seen on PR #24911, linked for reference only):

- `rspec ./spec/features/work_packages/table/switch_types_spec.rb[1:1:1]`
- `rspec ./spec/features/work_packages/table/switch_types_spec.rb[1:1:2]`

Treat this as a standalone task, unrelated to PR #24911. Create a new branch from origin/dev and open a new pull request targeting dev — do not stack it on PR #24911 or reuse that branch.

Follow the playbook in docs/development/testing/handling-flaky-tests/README.md to find the root cause and fix the underlying race — do not skip, delete, or weaken the spec to make it pass; disabling is a last resort per the playbook, and only with a bug ticket. Verify the fix by running the spec(s) repeatedly (e.g. `script/bulk_run_rspec --run-count 10`).

If you cannot reproduce the flake or are not confident in a fix after reasonable investigation, do not fabricate a change or skip the spec to force CI green. Instead, leave the pull request in draft and document what you tried, the suspected cause, and any leads in its description, then assign @brunopagno to take over.

Once the fix is verified, title the PR after the spec(s) it fixes, and use the PR description to explain the root cause, how the change resolves it, and the before/after results. Label the PR `flaky-spec`, assign @brunopagno, and request a review from @brunopagno.
On every commit, set @brunopagno as the sole co-author with a `Co-authored-by:` trailer (use their GitHub no-reply email so it links to their account), so it is traceable who dispatched the fix.

@brunopagno brunopagno changed the title [COMMS-887] Observed in versions - API changes [COMMS-887] Observed in versions API + Details/List view Aug 24, 2026
@github-actions

Copy link
Copy Markdown

Warning

Flaky specs

  • rspec ./modules/wikis/spec/features/admin/internal_provider_spec.rb[1:1]
  • rspec ./spec/features/work_packages/table/switch_types_spec.rb[1:1:1]
  • rspec ./spec/features/work_packages/table/switch_types_spec.rb[1:1:2]
🤖 Ask Copilot to investigate

Copy the prompt below into a new comment on this PR to delegate the investigation to GitHub Copilot. It will look into the flakiness and open a separate pull request with you as reviewer.

@copilot The following spec(s) are flaky in CI (first seen on PR #24911, linked for reference only):

- `rspec ./modules/wikis/spec/features/admin/internal_provider_spec.rb[1:1]`
- `rspec ./spec/features/work_packages/table/switch_types_spec.rb[1:1:1]`
- `rspec ./spec/features/work_packages/table/switch_types_spec.rb[1:1:2]`

Treat this as a standalone task, unrelated to PR #24911. Create a new branch from origin/dev and open a new pull request targeting dev — do not stack it on PR #24911 or reuse that branch.

Follow the playbook in docs/development/testing/handling-flaky-tests/README.md to find the root cause and fix the underlying race — do not skip, delete, or weaken the spec to make it pass; disabling is a last resort per the playbook, and only with a bug ticket. Verify the fix by running the spec(s) repeatedly (e.g. `script/bulk_run_rspec --run-count 10`).

If you cannot reproduce the flake or are not confident in a fix after reasonable investigation, do not fabricate a change or skip the spec to force CI green. Instead, leave the pull request in draft and document what you tried, the suspected cause, and any leads in its description, then assign @brunopagno to take over.

Once the fix is verified, title the PR after the spec(s) it fixes, and use the PR description to explain the root cause, how the change resolves it, and the before/after results. Label the PR `flaky-spec`, assign @brunopagno, and request a review from @brunopagno.
On every commit, set @brunopagno as the sole co-author with a `Co-authored-by:` trailer (use their GitHub no-reply email so it links to their account), so it is traceable who dispatched the fix.

@brunopagno
brunopagno requested a review from a team August 24, 2026 14:29
@brunopagno

Copy link
Copy Markdown
Contributor Author

Hey @opf/communicator who reviews this PR. I ended up doing a 2 in 1, by adding the fields to the API + adjusting display on the UI, because adding a field to the work_package_schema_representer includes things on the UI by default.

I believe I covered everything that needed to be done, but I'd appreciate a patient review as this effectively introduces the new field to all users (albeit not visible by default needs to be manually added to a type)

@thykel
thykel marked this pull request as ready for review August 25, 2026 19:58
@github-actions

Copy link
Copy Markdown

Caution

The provided work package version does not match the core version

Details:

Please make sure that:

  • The work package version OR your pull request target branch is correct

Comment thread config/locales/en.yml Outdated
Comment thread app/models/type/attribute_groups.rb Outdated
Comment thread app/models/type/attribute_groups.rb Outdated
Comment thread docs/api/apiv3/components/schemas/work_package_model.yml Outdated
@github-actions

Copy link
Copy Markdown

Warning

Flaky specs

  • rspec ./spec/features/admin/attribute_help_texts_spec.rb[1:1:1:1]
🤖 Ask Copilot to investigate

Copy the prompt below into a new comment on this PR to delegate the investigation to GitHub Copilot. It will look into the flakiness and open a separate pull request with you as reviewer.

@copilot The following spec(s) are flaky in CI (first seen on PR #24911, linked for reference only):

- `rspec ./spec/features/admin/attribute_help_texts_spec.rb[1:1:1:1]`

Treat this as a standalone task, unrelated to PR #24911. Create a new branch from origin/dev and open a new pull request targeting dev — do not stack it on PR #24911 or reuse that branch.

Follow the playbook in docs/development/testing/handling-flaky-tests/README.md to find the root cause and fix the underlying race — do not skip, delete, or weaken the spec to make it pass; disabling is a last resort per the playbook, and only with a bug ticket. Verify the fix by running the spec(s) repeatedly (e.g. `script/bulk_run_rspec --run-count 10`).

If you cannot reproduce the flake or are not confident in a fix after reasonable investigation, do not fabricate a change or skip the spec to force CI green. Instead, leave the pull request in draft and document what you tried, the suspected cause, and any leads in its description, then assign @brunopagno to take over.

Once the fix is verified, title the PR after the spec(s) it fixes, and use the PR description to explain the root cause, how the change resolves it, and the before/after results. Label the PR `flaky-spec`, assign @brunopagno, and request a review from @brunopagno.
On every commit, set @brunopagno as the sole co-author with a `Co-authored-by:` trailer (use their GitHub no-reply email so it links to their account), so it is traceable who dispatched the fix.

@brunopagno
brunopagno requested a review from thykel August 26, 2026 08:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants