Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove consultations module #11171

Merged
merged 8 commits into from Jul 24, 2023
Merged

Remove consultations module #11171

merged 8 commits into from Jul 24, 2023

Conversation

andreslucena
Copy link
Member

馃帺 What? Why?

Since January 2021, we've decided that Consultations no longer be maintained, as we were working in the alternative: decidim-elections.

We've let people know that this is the case through the documentation and also by a callout (see #7095) available from version v0.24.0.

The time has come for it to die, as in the future v0.28, it was not even redesigned, so this PR removes it.

馃搶 Related Issues

Testing

All the suite should be green.
There should not be any more reference to decidim-consultations or consultations in the code/docs/etc.

鈾ワ笍 Thank you!

@andreslucena andreslucena added module: consultations type: removal PRs that implement a removal of a functionality or code labels Jul 12, 2023
@andreslucena andreslucena changed the title Remove decidim-consultations module directory Remove decidim-consultations module Jul 12, 2023
@andreslucena andreslucena changed the title Remove decidim-consultations module Remove consultations module Jul 12, 2023
@alecslupu
Copy link
Contributor

@andreslucena I was briefly looking through this PR, and i could find some places where we still have consultations ...

Maye we need to purge also the following:

  • decidim/decidim-core/lib/tasks/upgrade/decidim_migrate_wysiwyg_content.rake # This is mandatory ...
  • decidim/decidim-core/app/controllers/decidim/user_activities_controller.rb
  • decidim/decidim-core/app/helpers/decidim/icon_helper.rb
  • decidim/decidim-core/app/models/decidim/action_log.rb
  • decidim/decidim-core/lib/tasks/decidim_active_storage_migration_tasks.rake
  • decidim/decidim-core/spec/cells/decidim/user_activity_cell_spec.rb
  • decidim/decidim-core/lib/decidim/carrier_wave_migrator_service.rb

@andreslucena andreslucena marked this pull request as draft July 13, 2023 06:27
@andreslucena andreslucena marked this pull request as ready for review July 13, 2023 10:05
@andreslucena
Copy link
Member Author

@alecslupu I think this is ready to be reviewed. The failing spec of the generator I understand that are from using the edge branch, if you want I can change them so it pass, whatever approach you prefer.

@alecslupu alecslupu requested a review from a team July 13, 2023 11:07
@alecslupu alecslupu self-assigned this Jul 13, 2023
@ahukkanen
Copy link
Contributor

Just a question that should we move the code to the archive repository?
https://github.com/decidim-archive/decidim-module-consultations

Of course the code will remain in the history of this repository but just thinking out loud when we have that archive existing as well.

@fblupi
Copy link
Member

fblupi commented Jul 13, 2023

Just a question that should we move the code to the archive repository? https://github.com/decidim-archive/decidim-module-consultations

Of course the code will remain in the history of this repository but just thinking out loud when we have that archive existing as well.

I agree with @ahukkanen. Maybe some integrators prefer to keep using it and make it compatible with the redesign.

@andreslucena
Copy link
Member Author

Just a question that should we move the code to the archive repository? decidim-archive/decidim-module-consultations

Of course the code will remain in the history of this repository but just thinking out loud when we have that archive existing as well.

Regarding that README, as we're linking here saying that now lives here, but that's not the case, I propose that we change that explanation:

# decidim-module-consultations

In 2018, this module was integrated into the main repository: [decidim/decidim](https://github.com/decidim/decidim).

In 2021, we started developing an alternative module called `decidim-elections` and initiated the deprecation process for the original module. We added a callout in the admin panel for this module:

>  Consultations module will be deprecated in the near future. We鈥檙e working on the next cryptographically secure version called Votings.  

In 2023, as part of the Redesign process, we removed the code for this module from the main repository. Please refer to PR [#11171](https://github.com/decidim/decidim/pull/11171) for more details.

If you wish to maintain a new version of this module, you can recover it using git:

---shell
git clone https://github.com/decidim/decidim
git restore -s <COMMIT> decidim-consultations
---

If you're maintaining a version of this module, please share the URL of the git repository by [creating an issue on the decidim.org website repository](https://github.com/decidim/decidim.org) so that we can update the [Modules page](https://decidim.org/modules).

Only two things that need to change: the format for the code block (it should be "```shell" instead of "---shell") and the commit hash that we need to add after merging this PR.

alecslupu
alecslupu previously approved these changes Jul 13, 2023
@alecslupu
Copy link
Contributor

alecslupu commented Jul 13, 2023

@andreslucena The PR is approved.

Since this is quite a big change, i would suggest to add some block text in the RELEASE_NOTES stating that we removed this module.
Also, i recommend to add it to the archive.

andreslucena added a commit to decidim-archive/decidim-module-consultations that referenced this pull request Jul 21, 2023
As we've already deprecated this module, and it isn't clear in the README, we update it to explain the history better.

Related to decidim/decidim#11171
@andreslucena
Copy link
Member Author

Since this is quite a big change, i would suggest to add some block text in the RELEASE_NOTES stating that we removed this module.

Done at f12553b

Notice that I've added it as a "General note", and also I've added a placeholder title for the Redesign, as that's much more important than this change.

Also, i recommend to add it to the archive.

Done at decidim-archive/decidim-module-consultations#89

I've added the current last commit hash, we should update it there if we merge another PR before this one (or we can just ignore it as we probably will not introduce changes in decidim-consultations, but just in case 馃槃)

@alecslupu
Copy link
Contributor

Both specs failing in generators are complaining about not finding the consultations module.

@alecslupu alecslupu merged commit da902e1 into develop Jul 24, 2023
91 of 92 checks passed
@alecslupu alecslupu deleted the remove/consultations-module branch July 24, 2023 07:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module: consultations type: removal PRs that implement a removal of a functionality or code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Redesign / Deprecate Decidim Consultations module
4 participants