Selecting resources to exclude from Engineering Workflow Management source control

Eclipse workspaces often include files or folders, such as compiler output, log files, and so on, that you do not want to place under source control. You can specify resources or classes of resources to be ignored by Engineering Workflow Management source control. Ignored resources are never checked in.

About this task

A .jazzignore file is used to prevent items from being checked into change sets. A .jazzignore file consists of a series of patterns. Any file, folder, or symbolic link whose name matches a pattern cannot be committed to a change set.

There are two types of patterns in a .jazzignore file: core.ignore patterns, that are effective in the same directory as the ignore file; and core.ignore.recursive patterns that affect items in all of the directories below the .jazzignore file.

A .jazzignore files can be contained anywhere under a shared folder. A .jazzignore file that is contained above a shared folder is not recognized.

Eclipse provides its own ignore facility but, unlike Engineering Workflow Management source control, does not support a way to share a list of ignored resources with your team. When you first use Engineering Workflow Management source control to share a project in your Eclipse workspace, the Share Project wizard prompts you to review any existing ignore patterns. Click Add ignore patterns in the wizard to see the list of patterns that are currently ignored by Eclipse. You can remove a pattern from the list by selecting it and clicking Remove Pattern. If you suspect that Eclipse is ignoring a resource for any reason, open the Engineering Workflow Management source control properties page for the resource and look for an Ignored due to line.

There are several ways to create and manage the list of ignored resources:
  • If a resource that you do not want to add to Engineering Workflow Management source control is displayed in an open change set or Unresolved folder, right-click it and click Ignore. The resource is added to the .jazzignore file, which becomes part of the current change set.
  • In the Eclipse Package Explorer view (or any Eclipse view that supports Team operations), right-click the resource and click Team > Add to ignore list. Files that are added to the ignore list are immediately removed from open change sets or the Unresolved folder, and the modified .jazzignore file becomes part of the current change set.
  • To remove a resource from the ignore list so that you can add it to a change set, right-click the resource and click Team > Remove from ignore list.
  • You can edit any .jazzignore file to add, change, or remove ignored patterns and file names recursively at any level of the tree. To specify names and patterns to be ignored in all folders of a project, add the names and patterns to the value of the core.ignore.recursive property in the .jazzignore file at the project root. For example, to ignore all files in a project that have suffixes .htm, .html, and .cat, set the value of core.ignore.recursive as follows:

    core.ignore.recursive= {*.htm} {*.html) {*.cat}

    To specify names and patterns to be ignored in a specific folder, add the names and patterns to the value of the core.ignore property in the .jazzignore file in that folder. You cannot override a global .jazzignore core.ignore.recursive entry by creating a .jazzignore in a subdirectory. If you do not have a core.ignore.recursive entry in the project root, you can declare one in a subdirectory and it will take effect in that directory and all subdirectories.
Note: A .jazzignore file is treated like any other file under Engineering Workflow Management source control. When you modify it, you must check it in to copy it to your repository workspace. If you are working with a team, you must deliver it before other team members can accept it to see its effects in their own workspaces.

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki