Projects
MintPress uses projects to organise environments, assets, changes, and workflows. A project can contain environments and assets. Changes can be deployed against projects, environments, and assets. Workflows can be executed within a project.
Depending on the type of project, you may not have access to assets or workflows.
This guide covers navigation and usage of the projects and the individual project details screens.
Navigating to the projects screen
To view and manage your projects:
- Log in to the GUI.
- Access projects from the navigation bar to see a table of all projects.
Features of the projects screen
The projects screen displays a table with several important columns:
| Column | Description |
|---|---|
| Name | The name of each project. This also provides a link to the project details screen for the project. |
| Code | A unique identifier for the project. |
| Description | A brief summary or purpose of the project. |
| Project type | The type of project: standard or enterprise. |
| Archived | This column indicates the archival status of the project, showing whether it has been archived. |
Initially, no projects will be listed, so your first step would be to create a project.
Buttons & links
| Buttons & links | Function |
|---|---|
| Create project | Add a new project. |
| Bulk operations | Perform operations on multiple projects, such as archiving. |
| CSV export | Download a CSV file containing the list of projects for reporting or record-keeping purposes. |
| Include archived projects | Whether to show archived projects in the table. |
Managing projects in the table
- Use checkboxes to select multiple projects for bulk operations.
- Click on a column heading to sort the contents of the table.
- Click on a project's name to navigate to its detailed view.
Exporting the projects table
To export the table of projects:
- Click the CSV export button.
- The CSV file will be downloaded.
The export function outputs all projects (archived and active) regardless of whether you select one or more projects via the checkbox.
Creating a project
To create a new project, follow these steps:
- Click on the create project button.
- Fill in the mandatory fields in the dialog, including the project type, name, and code.
- (Optional) Add a description to clarify the project's purpose for other users.
- Click the create project button to finalise the creation of your project. You will then be taken to the project details screen for the newly created project.
- For projects involving assets, select enterprise as the project type.
- The values entered for name and code must be unique. i.e. There cannot be more than one project with the same code or name.
Understanding the project details screen
Once you've selected a project, you'll be taken to its details screen, which includes several features:
Features of the project details screen
This screen manages and defines the available assets, environments, properties, settings, asset templates, workflows, and Git remotes.
For enterprise projects, the project details screen also provides a filtered view of the activity run against the project itself. You can also create changes and run workflows from here. `Standard projects can't own changes directly nor run workflows which is why they don't have an activity tab.
Only enterprise projects have assets, asset templates, and workflows.
Buttons & links
| Buttons & links | Function |
|---|---|
| Pencil icon | Allows you to edit the details of associated data. |
| Code snippet icon | Displays the API links for the project. |
| Bookmarks icon | Provides access to the bookmarks defined for the project. |
Activity tab
This tab lists the changes and workflows that have been executed for the project.
Standard type projects do not have the activity tab on the project details page.
Automated changes tab
This tab lists the automated changes defined for the project.
Standard type projects do not have the automated changes tab on the project details page.
Environments tab
This tab lists the environments available for the project.
Assets tab
This tab lists the assets available for the project. It only shows assets that are immediate children of the project - assets belonging to an environment must be accessed via the environment details screen.
Standard type projects do not have the assets tab on the project details page.
Properties tab
A set of properties can be specified against a project. The properties are then available to the actions that are executed within the project. 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 project and its children.
Asset templates
This tab lists all the asset templates created for the project.
Standard type projects do not have the asset templates tab on the project details page.
Workflows
Workflows can be used to sequence changes, approval steps, wait steps, and other workflows.
Standard type projects do not have the workflows tab on the project details page.
Git remotes
Git manages the configuration and code associated with changes. This tab allows management of the Git remotes available for this project.