Changes between Version 1 and Version 2 of TracUpgrade


Ignore:
Timestamp:
Jan 13, 2020, 11:28:03 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracUpgrade

    v1 v2  
    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
     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
    76108==== Upgrading from Trac 0.12 to Trac 1.0 #to1.0
    77109
    78110===== Python 2.4 no longer supported
     111
    79112Upgrade Python to at least 2.5, but not 3.0.
    80113
    … …  
    84117
    85118* [https://trac-hacks.org/wiki/BatchModifyPlugin BatchModifyPlugin]
    86 * ​[https://trac-hacks.org/wiki/GitPlugin GitPlugin]
     119* [https://trac-hacks.org/wiki/GitPlugin GitPlugin]
    87120* [https://trac-hacks.org/wiki/OverrideEditPlugin OverrideEditPlugin]
    88121
    … …  
    90123
    91124===== Subversion components not enabled by default for new installations
     125
    92126The 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:
    93127{{{#!ini
    … …  
    95129tracopt.versioncontrol.svn.* = enabled
    96130}}}
     131
    97132The upgrade procedure should take care of this and change the TracIni appropriately, unless you already had the svn components explicitly disabled.
    98133
    99134===== Attachments migrated to new location
     135
    100136Another 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.
    101137
    102138===== Behavior of `[ticket] default_owner` changed
     139
    103140Prior 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.
    104141
    … …  
    106143
    107144===== Python 2.3 no longer supported
     145
    108146The minimum supported version of Python is now 2.4.
    109147
    110148===== SQLite v3.x required
     149
    111150SQLite 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.
    112151
    113152===== [trac:PySqlite] 2 required
     153
    114154[trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below.
    115155
    … …  
    119159
    120160* [https://trac-hacks.org/wiki/AutoQueryPlugin AutoQueryPlugin]
    121 * ​[https://trac-hacks.org/wiki/AdminConsoleProviderPatch AdminConsoleProviderPatch]
     161* [https://trac-hacks.org/wiki/AdminConsoleProviderPatch AdminConsoleProviderPatch]
    122162* [https://trac-hacks.org/wiki/AnchorMacro AnchorMacro]: see WikiFormatting#SettingAnchors
    123163* [https://trac-hacks.org/wiki/TicketChangePlugin TicketChangePlugin]: see [TracPermissions#TicketSystem TICKET_EDIT_COMMENT permission]
    … …  
    130170
    131171===== Multiple Repository Support
     172
    132173The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration.
    133174
    … …  
    143184
    144185===== Improved repository synchronization
     186
    145187In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories.
    146188
    … …  
    150192
    151193===== Authz permission checking
     194
    152195The 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.
    153196
    154197===== Microsecond timestamps
     198
    155199All 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.
    156200
    157201==== Upgrading from Trac 0.10 to Trac 0.11
     202
    158203===== Site Templates and Styles
     204
    159205The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information.
    160206
    … …  
    162208
    163209===== Trac Macros, Plugins
     210
    164211The 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.
    165212
    166213===== For FCGI/WSGI/CGI users
     214
    167215For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file:
    168216{{{#!sh
    … …  
    173221
    174222===== Web Admin plugin integrated
     223
    175224If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11.
    176225
    177226===== New Default Configurable Workflow
    178227
    179 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.
    180 
    181 Graphically, that looks like this:
     228When 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:
    182229
    183230{{{#!Workflow width=500 height=240
    … …  
    199246}}}
    200247
    201 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.
    202 
    203 ===== Global Configuration
    204 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.
     248There 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.
    205249
    206250=== 7. Restart the Web Server #RestarttheWebServer
    … …  
    214258Trac 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.
    215259
    216 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.
     260The 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.
    217261
    218262=== !ZipImportError
    … …  
    222266
    223267=== Wiki Upgrade
     268
    224269`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.
    225270
    … …  
    229274
    230275=== Parent dir
     276
    231277If you use a Trac parent env configuration and one of the plugins in one child does not work, none of the children will work.
    232278
    … …  
    243289=== Changing Database Backend
    244290
    245 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.
     291The [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.
    246292
    247293=== Upgrading from older versions of Trac #OlderVersions