How It Works
When you push changes to yourmain branch:
- Detect - Pipeline identifies which packages changed
- Version - Automatically bumps the patch version in
publisher.json - Publish - Deploys packages to your Credible environment
Prerequisites
- A GitHub repository for your packages
- Admin access to the repository
- A Credible organization and environment
Setup
Step 1: Create Repository from Template
- Go to the CI/CD template repository
- Click “Use this template” → “Create a new repository”
- Choose your organization and enter a repository name
Step 2: Configure GitHub App
The CI/CD bot needs a GitHub App to commit version bumps back to your repository. Create the App:- Go to your GitHub organization: Settings → Developer settings → GitHub Apps → New GitHub App
- Configure:
- Name:
credible-cicd-bot - Webhook: Uncheck “Active”
- Repository permissions: Contents (Read/Write), Pull requests (Read/Write), Metadata (Read)
- Installation: “Only on this account”
- Name:
- Click Create GitHub App
- Note the App ID at the top of the page
- Scroll to Private keys → Generate a private key (save the
.pemfile) - Go to Install App → Install on your repository
Step 3: Configure Secrets
Go to your repository: Settings → Secrets and variables → Actions → New repository secretGenerate a Credible API token using the CLI:
cred add group-access-token. See CLI documentation for details.
Step 4: Configure Variables
Go to: Settings → Secrets and variables → Actions → VariablesStep 5: Configure Branch Protection
- Go to Settings → Branches → Add branch protection rule
- Branch name pattern:
main - Enable:
- Allow specified actors to bypass required pull requests → Add
credible-cicd-bot - Require status checks to pass before merging
- Restrict who can push to matching branches → Add
credible-cicd-bot
- Allow specified actors to bypass required pull requests → Add
Repository Structure
Your repository should follow this structure:publisher.json: