Publish and Register an Agama Project in the Catalog

The Publish Agama project is a feature designed to prepare a project for production. This process involves transferring the project from the pre-release repository to a new repository, i.e., published repository. The published repository can then be registered in the Agama-lab Project catalog, making it accessible to other Agama-lab users.

You need it only when you plan to add your project to the Project Catalog, so the community can use your Agama flow and easily add your security rules.

Your agama flow code should always be in a public repository. As per all use cases of repositories, there are 2 repository categories that you will have during the publish project process.

Before you begin:

• You have a GitHub account linked to your Gluu workspace.
• You have an existing Agama project in Agama Lab that you’re ready to publish.
• You have permission to create repositories under the target GitHub owner (personal account or organization).
• You have permission to submit projects to the Project Catalog.

Publish and Register Project

Step 1: Create the GitHub repository

To publish a project, the user must create an empty repository on GitHub. The initial specifications for the new repository include:

• A repository description. The repository must be set to public visibility.

• An initial commit is mandatory; the user can achieve this by initializing the repository and adding a README.md file. For the project to be useful to others, the README should cover its various aspects in detail. The README should follow the Agama password project’s README as a template.

• Add topics after you create the repository.

Step 2: Open the project in Agama Lab

Open your already developed Agama project in Agama-Lab. It will be your pre-release repository. Navigate to the project details page.

Step 3: Publish the project

To initiate the project publishing process, right-click on the file explorer and choose the Publish Project option.

Upon selecting the Publish Project option, a publish form dialog will appear. The user is required to input the release version and the URL of the target repository, which, in this case, is the repository that the user has just created.

Subsequently, click on the Publish button. The system will proceed to push the project contents to the target repository, generating an initial release version based on the provided input.

Result of the Published Repository:

The Project Catalog is the public directory inside Agama Lab where published projects become discoverable and installable by the Gluu community. Before registering, make sure your GitHub repository has a description and at least one topic. The catalog validation requires both.

Step 4: Open the Project Catalog

Access the Project Catalog page by clicking on the Project Catalog menu in the sidebar.

Subsequently, click on the Add Project button. This action will display the wizard form registration dialog.

Step 5: Select and validate the repository

Click on the repository selection input; a loader will appear, indicating that it is awaiting the retrieval of user repository data. Proceed by searching for the repository by its name.

Click Next to advance to the next step. The system will provide feedback to the user regarding the selected repository.

If the feedback indicates errors, such as missing repository descriptions, the user can address and resolve them directly on the GitHub repository. An example of rectifying feedback errors involves addressing the issue of missing topics directly on the GitHub repository. Click the repository link to open the selected repository in a new tab.

To add repository descriptions, click on the gear icon located in the About section. This action will open the repository details dialog.

Fill in the description in the Edit Repository Details form. Subsequently, click on the Save Changes button to save the modifications.

Return to the Agama-lab application, and click on the Refresh button. This action will re-validate the repository.

If the feedback indicates no errors, you can proceed to the next step.

Step 6: Add a logo and finish

Review your submission and optionally upload a custom logo. Click Finish to register the project in the Project catalog.

The system will generate the logo for the user if the logo is not uploaded.

A success message will be displayed, and the system will notify the Agama-Lab team to review the submitted repository. The project will be visible in the Agama-Lab Project catalog.