@itentialopensource/push-bundle-to-github
v0.0.10-2021.2.1
Published
Push Bundle To GitHub
Readme
Push Bundles to GitHub
Table of Contents
Overview
The Push Bundles to GitHub pre-built takes an Admin Essentials installed pre-built and creates a new project in GitHub using the up-to-date pre-built bundle. If the project and branch 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.
Installation Prerequisites
Users must satisfy the following pre-requisites:
- Itential Automation Platform
^2021.2
- App-Artifacts
6.1.16-2021.1.2
- 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
- Helps to handle "Artifact-As-Code" with version control, PR, and code-promotion procedures.
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.
How to Run
Use the following to run the artifact:
- In Automation Catalog, find the Push Bundles to GitHub entry.
- Fill out the form with the appropriate values.
- Continue with all manual tasks in the workflow.
Form Inputs (look for above screenshot for example inputs)
- Adapter Name - Adapter name configured with user token
- GitHub Project Name - Project name in GitHub to Update/Create
- GitHub Organization Name - GitHub organization name to push repository
- Re-discover - Perform re-discover
- Artifact - name of the installed bundle to push onto remote repo
- PR Type - Type of PR (patch/minor/major)
- Commit Message - Commit message to add for commit tasks
- Target Branch - Traget branch to set for PR
