Changes between Version 4 and Version 5 of TracUpgrade


Ignore:
Timestamp:
Mar 23, 2021, 7:32:15 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracUpgrade

    v4 v5  
    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
    … …  
    4442This command will not have any effect if the environment is already up-to-date.
    4543
    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:
    48 {{{#!sh
    49 trac-admin /path/to/projenv upgrade --no-backup
    50 }}}
     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}}}
    6761
    68 this will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`.
    69 
    70 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.
     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.
    7166{{{#!comment
    7267Remove above note once #9936 is fixed.
    7368}}}
     69}}}
    7470
    7571=== 6. Steps specific to a given Trac version
    7672
     73==== Upgrading from Trac 1.0 to 1.2 #to1.2
     74
     75===== Python 2.5 no longer supported
     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.
     95
     96===== New permissions policy for read-only wiki pages
     97
     98Since 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:
     99{{{#!ini
     100[trac]
     101permission_policies = ReadonlyWikiPolicy,
     102 DefaultPermissionPolicy,
     103 LegacyAttachmentPolicy
     104}}}
     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.
     119
    77120==== Upgrading from Trac 0.12 to Trac 1.0 #to1.0
    78121
    … …  
    86129
    87130* [https://trac-hacks.org/wiki/BatchModifyPlugin BatchModifyPlugin]
    88 * ​[https://trac-hacks.org/wiki/GitPlugin GitPlugin]
     131* [https://trac-hacks.org/wiki/GitPlugin GitPlugin]
    89132* [https://trac-hacks.org/wiki/OverrideEditPlugin OverrideEditPlugin]
    90133
    … …  
    92135
    93136===== Subversion components not enabled by default for new installations
     137
    94138The 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:
    95139{{{#!ini
    … …  
    97141tracopt.versioncontrol.svn.* = enabled
    98142}}}
     143
    99144The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled.
    100145
    101146===== Attachments migrated to new location
     147
    102148Another 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.
    103149
    104150===== Behavior of `[ticket] default_owner` changed
     151
    105152Prior 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.
    106153
    … …  
    124171
    125172* [https://trac-hacks.org/wiki/AutoQueryPlugin AutoQueryPlugin]
    126 * ​[https://trac-hacks.org/wiki/AdminConsoleProviderPatch AdminConsoleProviderPatch]
     173* [https://trac-hacks.org/wiki/AdminConsoleProviderPatch AdminConsoleProviderPatch]
    127174* [https://trac-hacks.org/wiki/AnchorMacro AnchorMacro]: see WikiFormatting#SettingAnchors
    128175* [https://trac-hacks.org/wiki/TicketChangePlugin TicketChangePlugin]: see [TracPermissions#TicketSystem TICKET_EDIT_COMMENT permission]
    … …  
    186233
    187234===== Web Admin plugin integrated
     235
    188236If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
    189237
    … …  
    210258}}}
    211259
    212 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.
    213 
    214 ===== Global Configuration
    215 In versions prior to 0.11, the global configuration was by default located in `$prefix/share/trac/conf/trac.ini` or `/etc/trac/trac.ini`, depending on the distribution. You may want to specify that file to inherit from when upgrading.  Literally, when upgrading you have to add an `[inherit]` section to your project's `trac.ini` file. Additionally, you have to move your customized templates and common images from `$prefix/share/trac/...` to the new location.
     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.
    216261
    217262=== 7. Restart the Web Server #RestarttheWebServer
    … …  
    225270Trac 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.
    226271
    227 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.
    228273
    229274=== !ZipImportError
    … …  
    233278
    234279=== Wiki Upgrade
     280
    235281`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.
    236282
    … …  
    240286
    241287=== Parent dir
     288
    242289If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
    243290
    … …  
    246293=== Upgrading Python
    247294
    248 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.
    249296
    250297==== Windows and Python 2.6
    251298
    252 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.
    253300
    254301=== Changing Database Backend