Environments

Environments are used to organise changes and assets within a project.

note

Environments within standard type projects can't contain assets.

Accessing the environments table screen

To view all environments within a project:

1. Log in to the GUI.
2. Click on projects on the navigation bar on the left side.
3. Navigate to your desired project.
4. Click on the environments tab to display the list of environments.

info

Initially, no environments will be listed, so your next step would be to create an environment for this project.

Features of the environment table screen

• Bulk operations: Performs actions on multiple environments, such as archiving.
• CSV export: Exports the table of the environments to a CSV file.

Environment table columns

Column	Description
Name	Displays the name of each environment, which can be clicked to access the environment details screen.
Code	Shows a unique identifier for the environment.
Description	Provides a short summary or purpose of the environment.
Archived	This column indicates the archival status of the environment, showing whether it has been archived or not.

Buttons & links

Buttons & links	Function
Create environment	Add a new environment to the project in MintPress.
Bulk operations	Perform operations on multiple environments, such as archiving.
CSV export	Download a CSV file listing environments for reporting or record-keeping purposes.
Pencil icon	Allows you to edit the details of associated data.
Bookmarks icon	Provides access to the bookmarks defined for the environment.

Managing environments in the table

• Use checkboxes to select multiple environments for bulk operations.
• Click on a column heading to sort the contents of the table.
• Click on an environment's name to navigate to its detailed view.

Exporting the environment table

To export the table of environments:

1. Click the CSV export button.
2. The CSV file will be downloaded by your browser. Your browser may ask where to save the file or may save it automatically into your downloads directory.

info

The export function outputs all environments (archived and active) regardless of whether you select one or more environments via the checkbox.

Creating a new environment

To create a new environment, follow these steps:

1. Click on the create environment button.
2. Fill in the mandatory fields in the dialog, including name and code.
3. (Optional) Add a description to clarify the purpose of the environment for other users.
4. Click the create environment button to finalise the creation of your environment. You will then be taken to the environment details screen for the newly created environment.

tip

The values entered for name and code must be unique within a project. i.e. There cannot be more than one environment with the same code or name.

Viewing the environment details

You can view the details of an environment by clicking on its name.

Environment details screen

This screen displays the activity (including changes), assets, properties and settings specific to this particular environment.

note

Environments within standard type projects do not have the asset tab on the environment details page.

Activity tab

Lists the changes that have been deployed in this environment.

Creating a new change

To initiate a new change:

1. Click the create change button.
2. Fill in all the mandatory details in the form, such as action, Git remote, and Git revision.
3. Confirm the creation by clicking the create change button.

Once the change is created, it will automatically appear in the activity table. You will be able to see the change being executed and the progress of the execution. You can also view the specific details for any change that is running.

note

1. The Git remote must be valid for the change creation to commence.
2. The Git revision will also be validated to ensure that it exists during change execution. If it does not, the change will still be executed but will result in a status of error.

Automated changes tab

This tab lists the automated changes defined for this environment.

Assets tab

This tab lists the assets available for this environment.

note

Standard type projects do not have the assets tab on the project details page.

Properties tab

A set of properties can be specified against an environment. The properties are then available to the actions that are executed within the environment. This allows the action to query the value and then influence the change.

Settings tab

The settings tab allows you to specify configuration options that apply to the environment and its children.