github-configure-package-managers

GitHub Configure Package Managers

Updates package manager configuration files in remote GitHub repositories so that developers resolve dependencies from Artifactory virtual repositories.

Inputs

• github_repos -- list of owner/repo (e.g., ["myorg/my-app", "myorg/my-lib"])
• project_key -- JFrog project key (used in repo naming)
• ecosystems -- list from: npm, maven, pip, go, docker, helm
• jfrog_url -- JFrog Platform URL (from $JFROG_URL)
• github_host -- GitHub host URL (e.g., https://github.com or https://github.mycompany.com)

Approach

For each repo in github_repos:

1. Shallow-clone the repo into a temp directory
2. Create a feature branch: jfrog-onboarding
3. Add/update the appropriate config files
4. Push the branch
5. Instruct the user to open a PR

Cloning and creating a branch

GITHUB_HOST="https://github.com"  # or from manifest
REPO="owner/repo"                  # from github_repos[]
BRANCH_NAME="jfrog-onboarding"    # from manifest github.branch_name

TMPDIR=$(mktemp -d)
git clone --depth 1 "${GITHUB_HOST}/${REPO}.git" "$TMPDIR/repo"
cd "$TMPDIR/repo"
git checkout -b "$BRANCH_NAME"

# ... add/update config files ...

git add -A && git commit -m "chore: configure package managers for JFrog Artifactory"
git push -u origin "$BRANCH_NAME"
cd / && rm -rf "$TMPDIR"

After pushing, instruct the user:

Branch jfrog-onboarding has been pushed to {repo}. Please open a PR to merge the package manager configuration changes.

Per-Ecosystem Configuration

npm

File: .npmrc (project root) Template: templates/package-managers/.npmrc

registry=https://{jfrog-url}/artifactory/api/npm/{project-key}-npm/
//{jfrog-url}/artifactory/api/npm/{project-key}-npm/:_authToken=${JFROG_NPM_TOKEN}
always-auth=true

Maven

File: .mvn/settings.xml Template: templates/package-managers/settings.xml

• Configures <mirror> to point all repos to the Artifactory virtual
• Configures <server> with credential placeholders