diff --git a/odoo_project_changelog/README.rst b/odoo_project_changelog/README.rst new file mode 100644 index 00000000..300cb2a3 --- /dev/null +++ b/odoo_project_changelog/README.rst @@ -0,0 +1,92 @@ +========================= +Odoo Project - Changelogs +========================= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:06757be51744d76ceef1dad049c603a1dfbf21bed97b8f57c373a9a53b318556 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fmodule--composition--analysis-lightgray.png?logo=github + :target: https://github.com/OCA/module-composition-analysis/tree/18.0/odoo_project_changelog + :alt: OCA/module-composition-analysis +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/module-composition-analysis-18-0/module-composition-analysis-18-0-odoo_project_changelog + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/module-composition-analysis&target_branch=18.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows to generate CHANGELOGs for repositories used within a +project. + +Changelogs are generated from ``git`` commits history, and take as input +source and target references from this repository (a commit SHA, branch, +tag...). Only relevant changes done will be listed to not clutter the +changelog (translations, unit tests or documentation updates won't be +listed). + +The output is an HTML page where the user can easily navigate, fold and +unfold sections. + +|Changelog| + +.. |Changelog| image:: https://raw.githubusercontent.com/OCA/module-composition-analysis/18.0/odoo_project_changelog/static/img/changelog.png + +**Table of contents** + +.. contents:: + :local: + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Camptocamp + +Contributors +------------ + +- Camptocamp + + - Sébastien Alix + +Maintainers +----------- + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +This module is part of the `OCA/module-composition-analysis `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/odoo_project_changelog/__init__.py b/odoo_project_changelog/__init__.py new file mode 100644 index 00000000..0650744f --- /dev/null +++ b/odoo_project_changelog/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/odoo_project_changelog/__manifest__.py b/odoo_project_changelog/__manifest__.py new file mode 100644 index 00000000..02b9c060 --- /dev/null +++ b/odoo_project_changelog/__manifest__.py @@ -0,0 +1,22 @@ +# Copyright 2024 Camptocamp SA +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl) +{ + "name": "Odoo Project - Changelogs", + "summary": "Generate Changelogs from repositories for installed modules.", + "version": "18.0.1.0.0", + "category": "Tools", + "author": "Camptocamp, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/module-composition-analysis", + "data": [ + "security/ir.model.access.csv", + "data/queue_job.xml", + "views/odoo_project.xml", + "report/ir_actions_report.xml", + "report/odoo_project_changelog.xml", + ], + "installable": True, + "depends": [ + "odoo_project", + ], + "license": "AGPL-3", +} diff --git a/odoo_project_changelog/data/queue_job.xml b/odoo_project_changelog/data/queue_job.xml new file mode 100644 index 00000000..9ceddeef --- /dev/null +++ b/odoo_project_changelog/data/queue_job.xml @@ -0,0 +1,29 @@ + + + + + odoo_project_changelog + + + + + + _generate_changelog + + + + + + + _generate_changelog_report + + + + diff --git a/odoo_project_changelog/i18n/it.po b/odoo_project_changelog/i18n/it.po new file mode 100644 index 00000000..d9a7582a --- /dev/null +++ b/odoo_project_changelog/i18n/it.po @@ -0,0 +1,211 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * odoo_project_changelog +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: Automatically generated\n" +"Language-Team: none\n" +"Language: it\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n != 1;\n" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.report_changelog +msgid "- CHANGELOG" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.odoo_project_view_form +msgid "" +"" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.actions.report,name:odoo_project_changelog.action_report_changelog +#: model:ir.actions.report,print_report_name:odoo_project_changelog.action_report_changelog +msgid "CHANGELOG" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.odoo_project_view_form +msgid "Changelog" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project__changelog_state +msgid "Changelog State" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project__changelog_url +msgid "Changelog Url" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,help:odoo_project_changelog.field_odoo_project_repository__target_commit +msgid "" +"Changelog is generated until this commit. If not set, the latest commit of " +"the branch is used." +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__create_uid +msgid "Created by" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__create_date +msgid "Created on" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.report_changelog +msgid "Date:" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__deployed_commit +msgid "Deployed Commit" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__display_name +msgid "Display Name" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields.selection,name:odoo_project_changelog.selection__odoo_project__changelog_state__done +msgid "Done" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project__changelog_enabled_repository_ids +msgid "Enabled Repositories for CHANGELOG" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.report_changelog +msgid "From" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.odoo_project_view_form +msgid "Generate CHANGELOG" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__id +msgid "ID" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields.selection,name:odoo_project_changelog.selection__odoo_project__changelog_state__in_progress +msgid "In progress" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__active +msgid "Include" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository____last_update +msgid "Last Modified on" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__write_uid +msgid "Last Updated by" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__write_date +msgid "Last Updated on" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.report_changelog +msgid "Link" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields.selection,name:odoo_project_changelog.selection__odoo_project__changelog_state__none +msgid "None" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model,name:odoo_project_changelog.model_odoo_project +msgid "Odoo Project" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.odoo_project_view_form +msgid "Open CHANGELOG" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__odoo_project_id +msgid "Project" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.odoo_project_view_form +msgid "Refresh" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.odoo_project_view_form +msgid "Repositories" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__repository_branch_id +msgid "Repository Branch" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model,name:odoo_project_changelog.model_odoo_project_repository +msgid "Repository used in a project" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__target_commit +msgid "Target Commit" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,help:odoo_project_changelog.field_odoo_project_repository__deployed_commit +msgid "The changelog is generated from this commit." +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.odoo_project_view_form +msgid "To compare with" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project__used_repository_ids +msgid "Used Repositories" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.report_changelog +msgid "change" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.report_changelog +msgid "modules)" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.report_changelog +msgid "to" +msgstr "" diff --git a/odoo_project_changelog/i18n/odoo_project_changelog.pot b/odoo_project_changelog/i18n/odoo_project_changelog.pot new file mode 100644 index 00000000..f04a6642 --- /dev/null +++ b/odoo_project_changelog/i18n/odoo_project_changelog.pot @@ -0,0 +1,210 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * odoo_project_changelog +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.report_changelog +msgid "- CHANGELOG" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.odoo_project_view_form +msgid "" +"" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.actions.report,name:odoo_project_changelog.action_report_changelog +#: model:ir.actions.report,print_report_name:odoo_project_changelog.action_report_changelog +msgid "CHANGELOG" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.odoo_project_view_form +msgid "Changelog" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project__changelog_state +msgid "Changelog State" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project__changelog_url +msgid "Changelog Url" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,help:odoo_project_changelog.field_odoo_project_repository__target_commit +msgid "" +"Changelog is generated until this commit. If not set, the latest commit of " +"the branch is used." +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__create_uid +msgid "Created by" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__create_date +msgid "Created on" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.report_changelog +msgid "Date:" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__deployed_commit +msgid "Deployed Commit" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__display_name +msgid "Display Name" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields.selection,name:odoo_project_changelog.selection__odoo_project__changelog_state__done +msgid "Done" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project__changelog_enabled_repository_ids +msgid "Enabled Repositories for CHANGELOG" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.report_changelog +msgid "From" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.odoo_project_view_form +msgid "Generate CHANGELOG" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__id +msgid "ID" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields.selection,name:odoo_project_changelog.selection__odoo_project__changelog_state__in_progress +msgid "In progress" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__active +msgid "Include" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository____last_update +msgid "Last Modified on" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__write_uid +msgid "Last Updated by" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__write_date +msgid "Last Updated on" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.report_changelog +msgid "Link" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields.selection,name:odoo_project_changelog.selection__odoo_project__changelog_state__none +msgid "None" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model,name:odoo_project_changelog.model_odoo_project +msgid "Odoo Project" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.odoo_project_view_form +msgid "Open CHANGELOG" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__odoo_project_id +msgid "Project" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.odoo_project_view_form +msgid "Refresh" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.odoo_project_view_form +msgid "Repositories" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__repository_branch_id +msgid "Repository Branch" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model,name:odoo_project_changelog.model_odoo_project_repository +msgid "Repository used in a project" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project_repository__target_commit +msgid "Target Commit" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,help:odoo_project_changelog.field_odoo_project_repository__deployed_commit +msgid "The changelog is generated from this commit." +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.odoo_project_view_form +msgid "To compare with" +msgstr "" + +#. module: odoo_project_changelog +#: model:ir.model.fields,field_description:odoo_project_changelog.field_odoo_project__used_repository_ids +msgid "Used Repositories" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.report_changelog +msgid "change" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.report_changelog +msgid "modules)" +msgstr "" + +#. module: odoo_project_changelog +#: model_terms:ir.ui.view,arch_db:odoo_project_changelog.report_changelog +msgid "to" +msgstr "" diff --git a/odoo_project_changelog/models/__init__.py b/odoo_project_changelog/models/__init__.py new file mode 100644 index 00000000..3efaabd9 --- /dev/null +++ b/odoo_project_changelog/models/__init__.py @@ -0,0 +1,2 @@ +from . import odoo_project_repository +from . import odoo_project diff --git a/odoo_project_changelog/models/odoo_project.py b/odoo_project_changelog/models/odoo_project.py new file mode 100644 index 00000000..dfa5321e --- /dev/null +++ b/odoo_project_changelog/models/odoo_project.py @@ -0,0 +1,85 @@ +# Copyright 2024 Camptocamp SA +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl) + +from urllib.parse import urljoin + +from odoo import fields, models + +from odoo.addons.queue_job.delay import chain +from odoo.addons.queue_job.job import identity_exact + + +class OdooProject(models.Model): + _inherit = "odoo.project" + + used_repository_ids = fields.One2many( + comodel_name="odoo.project.repository", + inverse_name="odoo_project_id", + string="Used Repositories", + context={"active_test": False}, + ) + changelog_enabled_repository_ids = fields.One2many( + comodel_name="odoo.project.repository", + inverse_name="odoo_project_id", + string="Enabled Repositories for CHANGELOG", + ) + changelog_state = fields.Selection( + selection=[ + ("none", "None"), + ("in_progress", "In progress"), + ("done", "Done"), + ], + default="none", + copy=False, + ) + changelog_url = fields.Char(compute="_compute_changelog_url") + + def _compute_changelog_url(self): + for rec in self: + rec.changelog_url = urljoin( + rec.get_base_url() + "/", + f"report/html/odoo_project_changelog.report_changelog/{rec.id}", + ) + + def action_generate_changelog(self): + self.ensure_one() + self.changelog_state = "in_progress" + self.used_repository_ids.changelog = False + jobs = self._create_jobs() + chain(*jobs).delay() + + def action_open_changelog(self): + return { + "type": "ir.actions.act_url", + "url": self.changelog_url, + "target": "_new", + "target_type": "public", + } + + def _create_jobs(self): + self.ensure_one() + jobs = [] + # Spawn jobs generating a changelog for each repository + for repo in self.used_repository_ids: + if not repo.active: + continue + delayable = repo.delayable( + description=( + f"Collect CHANGELOG data for {self.display_name}, " + f"repository {repo.repository_branch_id.display_name}" + ), + identity_key=identity_exact, + ) + job = delayable._generate_changelog() + jobs.append(job) + # Spawn job updating the CHANGELOG state to done + delayable = self.delayable( + description=(f"Set CHANGELOG as ready for {self.display_name}"), + identity_key=identity_exact, + ) + job = delayable._set_changelog_done() + jobs.append(job) + return jobs + + def _set_changelog_done(self): + self.changelog_state = "done" diff --git a/odoo_project_changelog/models/odoo_project_repository.py b/odoo_project_changelog/models/odoo_project_repository.py new file mode 100644 index 00000000..fb30e737 --- /dev/null +++ b/odoo_project_changelog/models/odoo_project_repository.py @@ -0,0 +1,87 @@ +# Copyright 2024 Camptocamp SA +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl) + +from odoo import fields, models + +from ..utils.scanner import ChangelogScannerOdooEnv + + +class OdooProjectRepository(models.Model): + _name = "odoo.project.repository" + _description = "Repository used in a project" + + odoo_project_id = fields.Many2one( + comodel_name="odoo.project", + ondelete="cascade", + string="Project", + required=True, + index=True, + readonly=True, + ) + repository_branch_id = fields.Many2one( + comodel_name="odoo.repository.branch", + ondelete="cascade", + string="Repository Branch", + required=True, + index=True, + ) + deployed_commit = fields.Char(help="The changelog is generated from this commit.") + target_commit = fields.Char( + help=( + "Changelog is generated until this commit. " + "If not set, the latest commit of the branch is used." + ) + ) + active = fields.Boolean(string="Include", default=True) + changelog = fields.Serialized() + + def _prepare_changelog_scanner_parameters(self): + ir_config = self.env["ir.config_parameter"] + odoo_repository = self.repository_branch_id.repository_id + repositories_path = ir_config.get_param(odoo_repository._repositories_path_key) + return { + "org": odoo_repository.org_id.name, + "name": odoo_repository.name, + "clone_url": odoo_repository.clone_url, + "odoo_project_repository_id": self.id, + "repositories_path": repositories_path, + "repo_type": odoo_repository.repo_type, + "ssh_key": odoo_repository.ssh_key_id.private_key, + "token": odoo_repository._get_token(), + "env": self.env, + } + + def _generate_changelog(self): + self.ensure_one() + params = self._prepare_changelog_scanner_parameters() + scanner = ChangelogScannerOdooEnv(**params) + scanner.scan() + + def push_changelog(self, changelog): + """Store the changelog. Called by the scanner.""" + self.ensure_one() + self.changelog = changelog + self.target_commit = self.changelog["target_commit"] + + def _get_report_data(self): + """Return data used by the CHANGELOG report.""" + self.ensure_one() + project_module_model = self.env["odoo.project.module"] + if not self.changelog.get("modules"): + return {"categories": {}, "count": 0} + # Collect all related categories and sort them by name + project_module_ids = [ + int(project_module_id) for project_module_id in self.changelog["modules"] + ] + project_modules = project_module_model.browse(project_module_ids).exists() + categories = project_modules.category_id.sorted( + key=lambda o: (o.name or "").lower() # Case insensitive + ) + data = {"categories": {categ: {} for categ in categories}} + data["categories"][self.env["odoo.module.category"]] = {} + data["count"] = len(self.changelog["modules"]) + for project_module_id, module_data in self.changelog["modules"].items(): + project_module = project_module_model.browse(int(project_module_id)) + categ = project_module.category_id + data["categories"][categ][project_module] = module_data + return data diff --git a/odoo_project_changelog/pyproject.toml b/odoo_project_changelog/pyproject.toml new file mode 100644 index 00000000..4231d0cc --- /dev/null +++ b/odoo_project_changelog/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/odoo_project_changelog/readme/CONTRIBUTORS.md b/odoo_project_changelog/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..17752927 --- /dev/null +++ b/odoo_project_changelog/readme/CONTRIBUTORS.md @@ -0,0 +1,2 @@ +- Camptocamp + - Sébastien Alix \ diff --git a/odoo_project_changelog/readme/DESCRIPTION.md b/odoo_project_changelog/readme/DESCRIPTION.md new file mode 100644 index 00000000..dfecbb1a --- /dev/null +++ b/odoo_project_changelog/readme/DESCRIPTION.md @@ -0,0 +1,10 @@ +This module allows to generate CHANGELOGs for repositories used within a project. + +Changelogs are generated from `git` commits history, and take as input source +and target references from this repository (a commit SHA, branch, tag...). +Only relevant changes done will be listed to not clutter the changelog +(translations, unit tests or documentation updates won't be listed). + +The output is an HTML page where the user can easily navigate, fold and unfold sections. + + ![Changelog](./static/img/changelog.png) diff --git a/odoo_project_changelog/report/ir_actions_report.xml b/odoo_project_changelog/report/ir_actions_report.xml new file mode 100644 index 00000000..c842549c --- /dev/null +++ b/odoo_project_changelog/report/ir_actions_report.xml @@ -0,0 +1,15 @@ + + + + + CHANGELOG + odoo.project + qweb-html + odoo_project_changelog.report_changelog + odoo_project_changelog.report_changelog + CHANGELOG + + report + + diff --git a/odoo_project_changelog/report/odoo_project_changelog.xml b/odoo_project_changelog/report/odoo_project_changelog.xml new file mode 100644 index 00000000..8f8f2053 --- /dev/null +++ b/odoo_project_changelog/report/odoo_project_changelog.xml @@ -0,0 +1,100 @@ + + + + + diff --git a/odoo_project_changelog/security/ir.model.access.csv b/odoo_project_changelog/security/ir.model.access.csv new file mode 100644 index 00000000..1964452d --- /dev/null +++ b/odoo_project_changelog/security/ir.model.access.csv @@ -0,0 +1,2 @@ +id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink +access_odoo_project_repository_user,odoo_project_repository_user,model_odoo_project_repository,odoo_repository.group_odoo_repository_user,1,1,1,1 diff --git a/odoo_project_changelog/static/description/icon.png b/odoo_project_changelog/static/description/icon.png new file mode 100644 index 00000000..1dcc49c2 Binary files /dev/null and b/odoo_project_changelog/static/description/icon.png differ diff --git a/odoo_project_changelog/static/description/index.html b/odoo_project_changelog/static/description/index.html new file mode 100644 index 00000000..110af0ed --- /dev/null +++ b/odoo_project_changelog/static/description/index.html @@ -0,0 +1,435 @@ + + + + + +Odoo Project - Changelogs + + + +
+

Odoo Project - Changelogs

+ + +

Beta License: AGPL-3 OCA/module-composition-analysis Translate me on Weblate Try me on Runboat

+

This module allows to generate CHANGELOGs for repositories used within a +project.

+

Changelogs are generated from git commits history, and take as input +source and target references from this repository (a commit SHA, branch, +tag…). Only relevant changes done will be listed to not clutter the +changelog (translations, unit tests or documentation updates won’t be +listed).

+

The output is an HTML page where the user can easily navigate, fold and +unfold sections.

+

Changelog

+

Table of contents

+ +
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Camptocamp
  • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

This module is part of the OCA/module-composition-analysis project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/odoo_project_changelog/static/img/changelog.png b/odoo_project_changelog/static/img/changelog.png new file mode 100644 index 00000000..bc3839e2 Binary files /dev/null and b/odoo_project_changelog/static/img/changelog.png differ diff --git a/odoo_project_changelog/utils/__init__.py b/odoo_project_changelog/utils/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/odoo_project_changelog/utils/scanner.py b/odoo_project_changelog/utils/scanner.py new file mode 100644 index 00000000..8405ca92 --- /dev/null +++ b/odoo_project_changelog/utils/scanner.py @@ -0,0 +1,50 @@ +# Copyright 2024 Camptocamp SA +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl) + +from odoo.addons.odoo_repository.lib.scanner import ChangelogScanner + + +class ChangelogScannerOdooEnv(ChangelogScanner): + """ChangelogScanner running on the same server than Odoo. + + This class takes an additional `env` parameter (`odoo.api.Environment`) + used to request Odoo, and implement required methods to use it. + """ + + def __init__(self, *args, **kwargs): + if kwargs.get("env"): + self.env = kwargs.pop("env") + super().__init__(*args, **kwargs) + + def _get_odoo_project_repository_data(self, project_repo_id): + project_repo = ( + self.env["odoo.project.repository"].browse(project_repo_id).exists() + ) + project = project_repo.odoo_project_id + data = { + "odoo_project_id": project.id, + "branch": project.odoo_version_id.name, + "source_commit": project_repo.deployed_commit, + "target_commit": project_repo.target_commit, + "modules": [ + # List of dicts {"id": PROJECT_MODULE_ID, ...} + # {"id": 1, "name": "base", "path": "odoo/addons/base"}, + # {"id": 2, "name": "account", "path": "addons/account"}, + {"id": mod.id, "name": mod.module_name, "path": mod.full_path} + for mod in project.project_module_ids.filtered_domain( + [ + ( + "repository_branch_id", + "=", + project_repo.repository_branch_id.id, + ) + ] + ) + ], + } + return data + + def _push_odoo_project_repository_changelog(self, project_repo_id, changelog): + self.env["odoo.project.repository"].browse( + project_repo_id + ).exists().push_changelog(changelog) diff --git a/odoo_project_changelog/views/odoo_project.xml b/odoo_project_changelog/views/odoo_project.xml new file mode 100644 index 00000000..490bf661 --- /dev/null +++ b/odoo_project_changelog/views/odoo_project.xml @@ -0,0 +1,63 @@ + + + + + odoo.project.form.inherit + odoo.project + + + + +
+
+ + + + + + + + + + +
+
+
+
+