How to store TFML files in a Git repository

Testfully Markup Language (TFML) files can be stored in a Git repository just like any other text files. This allows you to version control your API requests, collections, folders, environments, vaults, cookies and more.

By storing TFML files in a Git repository, you can track changes to your API requests and collaborate with your colleagues more effectively. Testfully Offline workspaces can take advantage of this feature to provide a seamless collaboration experience to users working in disconnected environments.

Integrating TFML with Git

To integrate TFML files with Git, you can follow these steps:

  • Create a new Git repository or clone an existing one.
  • Create a folder in the repository to store your TFML files, or use the root of the repository.
  • Create a file-based collection in Testfully, provide the local absolute path to the folder you created in the previous step, or use the root of the repository.
  • Start adding requests, folders and sub-folders to the collection using Testfully's UI or by creating TFML files manually.
  • Commit your changes to the Git repository using your preferred Git client or command line.

Ignore files

If your codebase and Testfully collections are stored in the same Git repository, you may want to signal Testfully to ignore certain files or directories that are not relevant to your API requests. You can do this by defining a .ignore, .testfully.ignore or testfully.ignore file in the root of your collection. This file follows the same syntax as .gitignore file, allowing you to specify files and directories that should be ignored by Testfully.