Feature/69562 add seeder migration that enables documents module by default for new projects #21561
+248
−24
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Generated by 🚫 Danger |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds the "documents" module to the default project modules when real-time text collaboration is enabled. The implementation includes a migration for existing installations, updates to the setting definition to make the default conditional, and seeder updates for new installations.
- Migration adds "documents" module to existing installations with collaboration enabled
- Setting definition now conditionally includes "documents" in default modules based on collaboration feature status
- Default value for real_time_text_collaboration_enabled changed from static
trueto check for required environment variables - Demo projects updated to include documents module
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| db/migrate/20260106151226_add_documents_to_default_projects_modules.rb | Migration that adds "documents" to default_projects_modules setting for existing installations when real-time collaboration is enabled |
| config/constants/settings/definition.rb | Updates default_projects_modules to conditionally include "documents" based on collaboration feature; changes real_time_text_collaboration_enabled default to check ENV variables |
| app/seeders/standard.yml | Adds "documents" module to demo projects (Demo project and Scrum project) |
| spec/migrations/add_documents_to_default_projects_modules_spec.rb | Tests for the migration covering enabled/disabled collaboration scenarios and edge cases |
| spec/models/setting_spec.rb | Tests for the conditional default logic in the setting definition |
akabiru
force-pushed
the
feature/69562-seeder-migration-enable-documents-module-per-default-for-new-projects
branch
from
d0b40f7 to
9ab26e6
Compare
akabiru
changed the title
akabiru
force-pushed
the
feature/69562-seeder-migration-enable-documents-module-per-default-for-new-projects
branch
3 times, most recently
from
11eee3a to
fed0e95
Compare
brunopagno
reviewed
Jan 7, 2026
Contributor
brunopagno
left a comment
brunopagno
left a comment
There was a problem hiding this comment.
This looks great, @akabiru
Left only one comment.
And probably still worth getting a review from the devops team 😁
cbliard
reviewed
Jan 8, 2026
Member
cbliard
left a comment
cbliard
left a comment
There was a problem hiding this comment.
Sounds good overall. I have some comments.
...les/documents/spec/features/documents/admin/settings/document_collaboration_settings_spec.rb
Outdated
Show resolved
Hide resolved
…abled Note: For existing instances, documents will only be added to defaults if real-time collaboration is enabled when the migration runs. Enabling collaboration later requires manual addition to default modules.
Ensures the real_time_text_collaboration_enabled setting exists before checking its value in the migration. This guards against potential edge cases where the setting definition might be removed in the future.
akabiru
force-pushed
the
feature/69562-seeder-migration-enable-documents-module-per-default-for-new-projects
branch
from
90129b2 to
6708d21
Compare
akabiru
deleted the
feature/69562-seeder-migration-enable-documents-module-per-default-for-new-projects
branch
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ticket
https://community.openproject.org/wp/69562
What are you trying to accomplish?
Right now, people need to add the Documents module manually per project. Ideally that module is turned on by default.
Only enable the default modules if real time text collaboration is enabled (by default should be OFF)
Merge checklist