{"id":18764796,"url":"https://github.com/bugzilla/bugzilla-schema","last_synced_at":"2025-12-07T12:30:15.916Z","repository":{"id":236726418,"uuid":"793033336","full_name":"bugzilla/bugzilla-schema","owner":"bugzilla","description":"A tool to generate documentation of the differences between Bugzilla schema versions","archived":false,"fork":false,"pushed_at":"2024-09-21T20:09:49.000Z","size":1194,"stargazers_count":1,"open_issues_count":0,"forks_count":7,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-10T20:52:03.937Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://schema.bugzilla.org","language":"Roff","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"Ravenbrook/bugzilla-schema","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bugzilla.png","metadata":{"files":{"readme":"readme.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-28T08:32:47.000Z","updated_at":"2024-12-13T15:42:08.000Z","dependencies_parsed_at":"2024-05-02T16:38:45.013Z","dependency_job_id":"676bcf5d-4222-40fa-b9ce-221fe5feaa12","html_url":"https://github.com/bugzilla/bugzilla-schema","commit_stats":null,"previous_names":["bugzilla/bugzilla-schema"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bugzilla%2Fbugzilla-schema","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bugzilla%2Fbugzilla-schema/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bugzilla%2Fbugzilla-schema/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bugzilla%2Fbugzilla-schema/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bugzilla","download_url":"https://codeload.github.com/bugzilla/bugzilla-schema/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239662746,"owners_count":19676435,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T18:31:35.768Z","updated_at":"2025-12-07T12:30:15.854Z","avatar_url":"https://github.com/bugzilla.png","language":"Roff","funding_links":[],"categories":[],"sub_categories":[],"readme":"Bugzilla Schema Doc Generation\n==============================\n\n1. Introduction\n---------------\n\nThis repository contains the code and documents used to generate\nthe `online Bugzilla schema documentation \u003chttps://schema.bugzilla.org/\u003e`_,\nproduced as a side-benefit\nof the `Perforce Defect Tracking Integration \u003chttp://www.ravenbrook.com/project/p4dti/\u003e`_ project.\n\n2. Index\n--------\n\n================== ====================================================================\nFile               Description\n================== ====================================================================\npickle_schema.py   A Python module to interrogate MySQL to obtain a live database\n                   schema, and to write a \"pickled\" version of that schema into a file\n                   in the \"pickles\" directory.\npickles            A directory containing pickled versions of every Bugzilla\n                   database schema, generated by pickle_schema.py.  Each pickle is\n                   named after the first version of Bugzilla which had that\n                   schema.\nget_schema.py      A Python module to read a pickled schema from the \"pickles\"\n                   directory, annotate it with data from schema_remarks.py, and convert\n                   it to a canonical Python dictionary form.\nschema_remarks.py  A Python module defining all the comments and running text which\n                   are ever used in the generated documentation (excluding\n                   automatically-generated text such as field names, types, attributes,\n                   and notes on schema changes).  Also lists the schemas available in\n                   \"pickles\", and provides the mapping from Bugzilla version to schema\n                   version name.\nmake_schema_doc.py The main Python documentation generation module.  Uses the\n                   unpickled schemas fetched by get_schema.py, compares them to\n                   identify schema changes and colour the resulting charts, processes\n                   the text to include comments appropriate to the range of schemas\n                   requested, and automated comments reflecting the schema version\n                   ranges specific to particular pieces of commentary, and produces the\n                   resulting HTML document.\nindex.py           The front-end CGI script which presents a form, validates input\n                   through the form, and drives make_schema_doc to produce the schema\n                   documentation.\nindex.cgi          A tiny Python script which uses index.py to do all of the CGI\n                   work.  The two files are separated so that the source of index.py\n                   can be published directly through the same web interface as the\n                   generated schemas.\n================== ====================================================================\n\n3. Requirements\n---------------\nFor hosting:\n\n- Python\n- a web server that can run Python CGI.\n\nFor updating:\n\n- The above, and also:\n- The ability to create Bugzilla installations for different versions of Bugzilla,\n  using MySQL.\n- MySQLdb.\n- Understanding of Perl, and of Bugzilla internals.\n- Patience.\n\nFor guidance on updating the tool to handle newer Bugzilla releases, see `updating.rst\u003cupdating.rst\u003e`_.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbugzilla%2Fbugzilla-schema","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbugzilla%2Fbugzilla-schema","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbugzilla%2Fbugzilla-schema/lists"}