Changes between Version 6 and Version 7 of Trac Upgrade


Ignore:
Timestamp:
Oct 25, 2020, 10:52:21 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Trac Upgrade

    v6 v7  
    1515=== 2. Update the Trac Code #UpdatetheTracCode
    1616
    17 Get the new version as described in TracInstall, or your operating system specific procedure.
    18 
    19 If you already have a 0.12 version of Trac installed via `easy_install`, it might be easiest to also use `easy_install` to upgrade your Trac installation:
    20 
    21 {{{#!sh
    22 easy_install --upgrade Trac==1.0
    23 }}}
    24 
    25 If you do a manual (not operating system-specific) upgrade, you should also stop any running Trac servers before the installation. Doing "hot" upgrades is not advised, especially on Windows ([trac:#7265]).
     17Get the new version as described in TracInstall, or through your operating system package manager.
     18
     19If you already an earlier version of Trac installed via `easy_install`, it might be easiest to also use `easy_install` to upgrade your Trac installation:
     20
     21{{{#!sh
     22easy_install --upgrade Trac
     23}}}
    2624
    2725You may also want to remove the pre-existing Trac code by deleting the `trac` directory from the Python `lib/site-packages` directory, or remove Trac `.egg` files from former versions.
    … …  
    3129 * on MacOSX: `/Library/Python/2.X/site-packages`
    3230
    33 You may also want to remove the Trac `cgi-bin`, `htdocs`, `templates` and `wiki-default` directories that are commonly found in a directory called `share/trac`. The exact location depends on your platform. This cleanup is not mandatory, but makes it easier to troubleshoot issues later on, as your installation is uncluttered by code or templates from a previous release that is not used anymore. As usual, make a backup before actually removing things.
     31You may also want to remove the directory in which your static resources are [TracInstall#cgi-bin deployed]. The exact location depends on your platform. This cleanup is not mandatory, but makes it easier to troubleshoot issues later on, as your installation is uncluttered by code or templates from a previous release that is not used anymore. As usual, make a backup before actually removing things.
    3432
    3533=== 3. Upgrade the Trac Environment #UpgradetheTracEnvironment
    … …  
    4240}}}
    4341
    44 This command will do nothing if the environment is already up-to-date.
    45 
    46 Note that a backup of your database will be performed automatically prior to the upgrade.
    47 This feature is relatively new for PostgreSQL or MySQL databases, so if it fails, you will have to backup the database manually. Then, to perform the actual upgrade, run:
    48 {{{#!sh
    49 trac-admin /path/to/projenv upgrade --no-backup
    50 }}}
     42This command will not have any effect if the environment is already up-to-date.
     43
     44Note that a backup of your database will be performed automatically prior to the upgrade. The backup will be saved in the location specified by `[trac]` `backup_dir`.
    5145
    5246=== 4. Update the Trac Documentation === #UpdatetheTracDocumentation
    … …  
    6155=== 5. Refresh static resources
    6256
    63 If you have set up a web server to give out static resources directly (accessed using the `/chrome/` URL) then you will need to refresh them using the same command:
     57If you have configured your web server to serve static resources directly (accessed using the `/chrome/` URL) then you will need to refresh them using the [TracInstall#MappingStaticResources same command]:
    6458{{{#!sh
    6559trac-admin /path/to/env deploy /deploy/path
    6660}}}
    67 this will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`.
    68 
    69 Some web browsers (IE, Opera) cache CSS and Javascript files aggressively, so you may need to instruct your users to manually erase the contents of their browser's cache, a forced refreshed (`<F5>`) should be enough.
     61
     62This will extract static resources and CGI scripts (`trac.wsgi`, etc) from the new Trac version and plugins into `/deploy/path`.
     63
     64{{{#!div style="border: 1pt dotted; margin: 1em"
     65**Note:** Some web browsers (IE, Opera) cache CSS and Javascript files, so you should instruct your users to manually erase the contents of their browser's cache. A forced refreshed (SHIFT + <F5>) should be enough.
    7066{{{#!comment
    7167Remove above note once #9936 is fixed.
    7268}}}
     69}}}
    7370
    7471=== 6. Steps specific to a given Trac version
    7572
    76 ==== Upgrading from Trac 1.0 to 1.1.x #to1.1.x
     73==== Upgrading from Trac 1.0 to 1.2 #to1.2
    7774
    7875===== Python 2.5 no longer supported
    79 Upgrade Python to at least 2.6, but not 3.0.
    80 
    81 ===== New workflow actions
    82 
    83 The ticket creation step is now controlled with a workflow action. The default workflow has `create` and `create_and_assign` actions. The `create` action will always be added when upgrading the database. The `create_and_assign` action will be added if the workflow has an //assigned// state. You may want to edit your workflow after upgrading the database to customize the actions available on the //New Ticket// page.
     76
     77Upgrade Python to at least 2.6 or 2.7, but not 3.0 or greater.
     78
     79===== Obsolete Plugins
     80
     81Trac has added functionality equivalent to the following plugins:
     82* [https://trac-hacks.org/wiki/AdminEnumListPlugin AdminEnumListPlugin]
     83* [https://trac-hacks.org/wiki/DateFieldPlugin DateFieldPlugin]: see the **time** [TracTicketsCustomFields#AvailableFieldTypesandOptions custom field type]
     84* [https://trac-hacks.org/wiki/GroupBasedRedirectionPlugin GroupBasedRedirectionPlugin]: the default handler can set as a user preference.
     85* [https://trac-hacks.org/wiki/LinenoMacro LinenoMacro]: see WikiProcessors#AvailableProcessors
     86* [https://trac-hacks.org/wiki/NeverNotifyUpdaterPlugin NeverNotifyUpdaterPlugin]: see [TracNotification#notification-subscriber-section notification subscribers]
     87* [https://trac-hacks.org/wiki/QueryUiAssistPlugin QueryUiAssistPlugin]: see TracQuery#Filters.
     88* [https://trac-hacks.org/wiki/TicketCreationStatusPlugin TicketCreationStatusPlugin]: see [#NewWorkflowActions]
     89
     90The plugins should be removed when upgrading Trac to 1.2.
     91
     92===== New workflow actions #NewWorkflowActions
     93
     94The ticket creation step is controlled with a [TracWorkflow#TicketCreateAction workflow action]. The default workflow has `create` and `create_and_assign` actions. The `create` action will always be added when upgrading the database. The `create_and_assign` action will be added if the workflow has an //assigned// state. You may want to edit your workflow after upgrading the database to customize the actions available on the //New Ticket// page.
    8495
    8596===== New permissions policy for read-only wiki pages
     97
    8698Since 1.1.2 the read-only attribute of wiki pages is enabled and enforced only when `ReadonlyWikiPolicy` is in the list of active permission policies. If `[trac] permission_policy` has the default value `DefaultPermissionPolicy, LegacyAttachmentPolicy`, then `ReadonlyWikiPolicy` should be automatically appended to the list when upgrading the environment:
    8799{{{#!ini
    … …  
    91103 LegacyAttachmentPolicy
    92104}}}
    93 If other permission policies are enabled, //trac.ini// will need to be edited to append `ReadonlyWikiPolicy` to the list of active `permission_policies`. See TracFineGrainedPermissions#ReadonlyWikiPolicy for additional details on the proper ordering.
     105
     106If other permission policies are enabled, `trac.ini` will need to have `ReadonlyWikiPolicy` appended to the list of active `permission_policies`. See TracFineGrainedPermissions#ReadonlyWikiPolicy for additional details on the proper ordering.
     107
     108===== Navigation Ordering Moved
     109
     110The mainnav and metanav configuration ordering have
     111been moved from `[trac]` `mainnav` and `[trac]` `metanav` to the `[mainnav]` and `[metanav]` sections. The ordering is now specified using the `order` attribute as described in [TracNavigation#nav-order TracNavigation].
     112
     113The new configuration values will be written to trac.ini on upgrade, preserving the navigation order for the environment. You may need to edit trac.ini
     114if you use a shared [TracIni#GlobalConfiguration global configuration].
     115For example, if you wish to specify the navigation ordering for several environments in `global.ini`, you'll
     116need to add the `[mainnav]` and `[metanav]` sections
     117in that file and delete those sections from each
     118environment's trac.ini.
    94119
    95120==== Upgrading from Trac 0.12 to Trac 1.0 #to1.0
    96121
    97122===== Python 2.4 no longer supported
     123
    98124Upgrade Python to at least 2.5, but not 3.0.
    99125
     126===== Obsolete Plugins
     127
     128Trac has added functionality equivalent to the following plugins:
     129
     130* [https://trac-hacks.org/wiki/BatchModifyPlugin BatchModifyPlugin]
     131* [https://trac-hacks.org/wiki/GitPlugin GitPlugin]
     132* [https://trac-hacks.org/wiki/OverrideEditPlugin OverrideEditPlugin]
     133
     134The plugins should be removed when upgrading Trac to 1.0.
     135
    100136===== Subversion components not enabled by default for new installations
     137
    101138The Trac components for Subversion support are no longer enabled by default. To enable the svn support, you need to make sure the `tracopt.versioncontrol.svn` components are enabled, for example by setting the following in the TracIni:
    102139{{{#!ini
    … …  
    104141tracopt.versioncontrol.svn.* = enabled
    105142}}}
     143
    106144The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled.
    107145
    108146===== Attachments migrated to new location
     147
    109148Another step in the automatic upgrade will change the way the attachments are stored. Create a backup of the `attachments` directory before upgrading. In case the `attachments` directory contains some files which are //not// attachments, the last step of the migration to the new layout will fail: the deletion of the now unused `attachments` directory can't be done if there are still files and folders in it. You may ignore this error, but better to move them elsewhere and remove the `attachments` directory manually. The attachments themselves are now all located in your environment below the `files/attachments` directory.
    110149
    111150===== Behavior of `[ticket] default_owner` changed
     151
    112152Prior to 1.0, the owner field of new tickets always defaulted to `[ticket] default_owner` when the value was not empty. If the value was empty, the owner field defaulted to to the Component's owner. In 1.0 and later, the `default_owner` must be set to `< default >` to make new tickets default to the Component's owner. This change allows the `default_owner` to be set to an empty value if no default owner is desired.
    113153
    … …  
    115155
    116156===== Python 2.3 no longer supported
     157
    117158The minimum supported version of Python is now 2.4.
    118159
    119160===== SQLite v3.x required
     161
    120162SQLite v2.x is no longer supported. If you still use a Trac database of this format, you'll need to convert it to SQLite v3.x first. See [trac:PySqlite#UpgradingSQLitefrom2.xto3.x] for details.
    121163
    122164===== [trac:PySqlite] 2 required
     165
    123166[trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below.
    124167
     168===== Obsolete Plugins
     169
     170Trac has added functionality equivalent to the following plugins:
     171
     172* [https://trac-hacks.org/wiki/AutoQueryPlugin AutoQueryPlugin]
     173* [https://trac-hacks.org/wiki/AdminConsoleProviderPatch AdminConsoleProviderPatch]
     174* [https://trac-hacks.org/wiki/AnchorMacro AnchorMacro]: see WikiFormatting#SettingAnchors
     175* [https://trac-hacks.org/wiki/TicketChangePlugin TicketChangePlugin]: see [TracPermissions#TicketSystem TICKET_EDIT_COMMENT permission]
     176* [https://trac-hacks.org/wiki/TicketDeletePlugin TicketDeletePlugin]: see `tracopt.ticket.deleter`
     177* [https://trac-hacks.org/wiki/SubversionLocationPlugin SubversionLocationPlugin]: see TracRepositoryAdmin#Repositories
     178* [https://trac-hacks.org/wiki/WikiCreoleRendererPlugin WikiCreoleRendererPlugin]: see [trac:WikiCreole]
     179* [https://trac-hacks.org/wiki/RepoRevisionSyntaxPlugin RepoRevisionSyntaxPlugin] (added in 0.12.1)
     180
     181The plugins should be removed when upgrading Trac to 0.12.
     182
    125183===== Multiple Repository Support
     184
    126185The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
    127186
    … …  
    137196
    138197===== Improved repository synchronization
     198
    139199In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
    140200
    … …  
    144204
    145205===== Authz permission checking
     206
    146207The authz permission checking has been migrated to a fine-grained permission policy. If you use authz permissions (aka `[trac] authz_file` and `authz_module_name`), you must add `AuthzSourcePolicy` in front of your permission policies in `[trac] permission_policies`. You must also remove `BROWSER_VIEW`, `CHANGESET_VIEW`, `FILE_VIEW` and `LOG_VIEW` from your global permissions with `trac-admin $ENV permission remove` or the "Permissions" admin panel.
    147208
    148209===== Microsecond timestamps
     210
    149211All timestamps in database tables, except the `session` table, have been changed from "seconds since epoch" to "microseconds since epoch" values. This change should be transparent to most users, except for custom reports. If any of your reports use date/time columns in calculations (e.g. to pass them to `datetime()`), you must divide the values retrieved from the database by 1'000'000. Similarly, if a report provides a calculated value to be displayed as a date/time (i.e. with a column named "time", "datetime", "changetime", "date", "created" or "modified"), you must provide a microsecond timestamp, that is, multiply your previous calculation with 1'000'000.
    150212
    151213==== Upgrading from Trac 0.10 to Trac 0.11
     214
    152215===== Site Templates and Styles
     216
    153217The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
    154218
    … …  
    156220
    157221===== Trac Macros, Plugins
     222
    158223The Trac macros will need to be adapted, as the old-style wiki-macros are not supported anymore due to the drop of [trac:ClearSilver] and the HDF. They need to be converted to the new-style macros, see WikiMacros. When they are converted to the new style, they need to be placed into the plugins directory instead and not wiki-macros, which is no longer scanned for macros or plugins.
    159224
    160225===== For FCGI/WSGI/CGI users
     226
    161227For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
    162228{{{#!sh
    … …  
    167233
    168234===== Web Admin plugin integrated
     235
    169236If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
    170237
    171238===== New Default Configurable Workflow
    172239
    173 When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section. The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10.
    174 
    175 Graphically, that looks like this:
     240When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section. The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10:
    176241
    177242{{{#!Workflow width=500 height=240
    … …  
    193258}}}
    194259
    195 There are some significant caveats in this, such as accepting a ticket sets it to 'assigned' state, and assigning a ticket sets it to 'new' state. So you will probably want to migrate to "basic" workflow; [trac:source:trunk/contrib/workflow/migrate_original_to_basic.py contrib/workflow/migrate_original_to_basic.py] may be helpful. See TracWorkflow for a detailed description of the new basic workflow.
     260There are some significant caveats in this, such as accepting a ticket sets it to 'assigned' state, and assigning a ticket sets it to 'new' state. So you will probably want to migrate to "basic" workflow; [trac:source:branches/1.2-stable/contrib/workflow/migrate_original_to_basic.py contrib/workflow/migrate_original_to_basic.py] may be helpful. See TracWorkflow for a detailed description of the new basic workflow.
    196261
    197262=== 7. Restart the Web Server #RestarttheWebServer
    … …  
    205270Trac supports customization of its Genshi templates by placing copies of the templates in the `<env>/templates` folder of your [TracEnvironment environment] or in a common location specified in the [[TracIni#GlobalConfiguration| [inherit] templates_dir]] configuration setting. If you choose to do so, be aware that you will need to repeat your changes manually on a copy of the new templates when you upgrade to a new release of Trac (even a minor one), as the templates will likely evolve. So keep a diff around.
    206271
    207 The preferred way to perform TracInterfaceCustomization is to write a custom plugin doing an appropriate `ITemplateStreamFilter` transformation, as this is more robust in case of changes: we usually won't modify element `id`s or change CSS `class`es, and if we have to do so, this will be documented in the [trac:TracDev/ApiChanges] pages.
     272The preferred way to perform TracInterfaceCustomization is to write a custom plugin doing an appropriate `ITemplateStreamFilter` transformation, as this is more robust in case of changes: we usually won't modify an element `id` or change its CSS `class`, and if we have to do so, this will be documented in the [trac:TracDev/ApiChanges] pages.
    208273
    209274=== !ZipImportError
    … …  
    213278
    214279=== Wiki Upgrade
     280
    215281`trac-admin` will not delete or remove default wiki pages that were present in a previous version but are no longer in the new version.
    216282
    … …  
    220286
    221287=== Parent dir
     288
    222289If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
    223290
    … …  
    226293=== Upgrading Python
    227294
    228 Upgrading Python to a newer version will require reinstallation of Python packages: Trac itself of course, but also [http://pypi.python.org/pypi/setuptools easy_install], if you've been using that. If you are using Subversion, you'll also need to upgrade the Python bindings for svn.
     295Upgrading Python to a newer version will require reinstallation of Python packages: Trac itself of course, but also [https://pypi.org/project/setuptools easy_install], if you've been using that. If you are using Subversion, you'll also need to upgrade the Python bindings for svn.
    229296
    230297==== Windows and Python 2.6
    231298
    232 If you've been using !CollabNet's Subversion package, you may need to uninstall that in favor of [http://alagazam.net/ Alagazam], which has the Python bindings readily available, see [trac:TracSubversion]. That package works without tweaking.
     299If you've been using !CollabNet's Subversion package, you may need to uninstall that in favor of [https://alagazam.net/ Alagazam], which has the Python bindings readily available, see [trac:TracSubversion]. That package works without tweaking.
    233300
    234301=== Changing Database Backend
    235302
    236 The [http://trac-hacks.org/wiki/TracMigratePlugin TracMigratePlugin] on [http://trac-hacks.org trac-hacks.org] has been written to assist in migrating between SQLite, MySQL and PostgreSQL databases.
     303The [https://trac-hacks.org/wiki/TracMigratePlugin TracMigratePlugin] on [https://trac-hacks.org trac-hacks.org] has been written to assist in migrating between SQLite, MySQL and PostgreSQL databases.
    237304
    238305=== Upgrading from older versions of Trac #OlderVersions