@itentialopensource/push-bundles-to-single-github-repo v0.0.12-2022.1.1

Push Bundles to Single GitHub Repo

Table of Contents

• Overview
• Installation Prerequisites
• Requirements
• Features
• How to Install
• How to Run

Overview

The Push Bundles to Single GitHub Repo pre-built takes an Admin Essentials installed pre-built and creates a new repository in GitHub using the up-to-date pre-built bundle. If the repository already exists in the specified GitHub group, it will create a new branch and open a pull request in GitHub with any changes made in the lab environment. Push Bundles to Single GitHub Repo supports having multiple pre-builts within the same repository. All components referenced in the pre-builts will be in the same location, while each pre-built will have their unique identifying information including its package.json, manifest.json, README.md, License, and generated artifact.json file. If multiple projects reference the same IAP component(s), the component will only exist in the repository once. Below is an example of the file structure that this pre-built creates.

Repository_Name
|-- bundles
|   |-- ac_agenda_job
|   |-- workflows
|   |-- json_forms
|   `-- ...
|-- scripts
|-- .github/workflows
`-- metadata
    |-- use-case-one
    |   |-- package.json
    |   |-- manifest.json
    |   |-- artifact.json
    |   |-- README.md
    |   `-- LICENSE
    `-- use-case-two
        `-- ...

Installation Prerequisites

Users must satisfy the following pre-requisites:

• Itential Automation Platform
  • ^2023.1
• App-Artifacts
  • 6.5.1-2023.1.0
• GitHub Adapter

Requirements

This artifact requires the following:

• Artifact installed in Admin Essentials
• GitHub Organization Name

Features

The main benefits and features of the artifact are outlined below.

• Automatically create repo and branch.
• Automatically create Pull Request when repo and branch exist.
• Allows user to perform rediscovery of an installed artifact (where new components were added).
• Adds the current IAP user whoami username to the Pull Request description for the Pull Request reviewer.
• Auto artifact.json generator script
• Auto version bump on push to project based on pull request type
• Avoid duplication of components across multiple Github projects
• Helps to handle "Artifact-As-Code" with version control, PR, and code-promotion procedures.

• Clean up of components that are no longer referenced by any projects

How to Install

To install this pre-built:

• Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Requirements section.
• The artifact can be installed from within App-Admin_Essential. Simply search for the name of your desired artifact and click the install button (as shown below).

How to Run

Use the following to run the artifact:

1. In Automation Catalog, find the Push Bundles to GitHub entry.
2. Fill out the form (as shown below) with the appropriate values.
3. Continue with all manual tasks in the workflow.

Form Inputs (look for above screenshot for example inputs) 1. Adapter Name - Adapter name configured with user token 2. GitHub Project Name - Project name in GitHub to Update/Create 3. GitHub Organization Name - GitHub organization name to push repository 4. Private Repo - Set repository visibility to private 5. Re-discover - Perform re-discover 6. Artifact - name of the installed bundle to push onto remote repo 7. PR Type - Type of PR (patch/minor/major) 8. Commit Message - Commit message to add for commit tasks 9. Target Branch - Traget branch to set for PR