Composer CLI Usage

Composer hosted repositories use the following package and metadata path structure:

/repository/<REPOSITORY_NAME>/
├── packages.json
├── p2/
│   └── <VENDOR>/
│       └── <PACKAGE>.json
└── <VENDOR>/
    └── <PACKAGE>/
        └── <VERSION>/
            └── <VENDOR>-<PACKAGE>-<VERSION>

Where,

Nexus Repository derives the vendor, package, and storage path from composer.json. Binary archives are stored without a file extension.

Nexus Repository normalizes Composer package names as follows:

The following examples show package-name normalization:

For a Components REST API upload, provide the request version through the version form field. For a direct repository upload, provide the request version through the version query parameter.

The following rules apply:

Neither version source overrides the other. When both sources provide a version, the values must match exactly.

Use the following endpoint for automated uploads and CI/CD workflows.

POST /service/rest/v1/components?repository={repository-name}

The following fields are available:

Use the following example when the version is defined in composer.json:

curl -u admin:admin123 \
  -F "[email protected];type=application/zip" \
  "http://example.nexus.com/service/rest/v1/components?repository=composer-hosted"

Use the following PUT endpoint to upload packages directly to a specific path in the repository:

PUT /repository/{repository-name}/

Use the following example when the version is defined in composer.json:

 curl -u admin:admin123 -X PUT \
  -H "Content-Type: application/zip" \
  --data-binary @acme-mypackage-1.0.0.zip \
  "http://example.nexus.com/repository/composer-hosted/"

When composer.json does not contain a version, supply it through the version query parameter as shown in the example:

 curl -u admin:admin123 -X PUT \
  -H "Content-Type: application/zip" \
  --data-binary @acme-mypackage-1.0.0.zip \
  "http://example.nexus.com/repository/composer-hosted/?version=1.0.0"

Use the following syntax for the Components REST API upload step in a GitLab CI/CD pipeline:

curl -u "${NEXUS_USER}:${NEXUS_PASSWORD}" \
  -F "asset=@${PACKAGE_FILE};type=application/zip" \
  "${NEXUS_URL}/service/rest/v1/components?repository=${NEXUS_REPO}"

Where,

Example:

stages:
  - build
  - publish

variables:
  NEXUS_URL: "https://example.nexus.com"
  NEXUS_REPO: "composer-hosted"
  # NEXUS_USER and NEXUS_PASSWORD should be set as GitLab CI/CD variables

build:package:
  stage: build
  image: composer:2
  script:
    # Create a valid composer.json if not exists
    - |
      if [ ! -f composer.json ]; then
        cat > composer.json <<EOF
      {
          "name": "mycompany/${CI_PROJECT_NAME}",
          "version": "${CI_COMMIT_TAG:-${CI_COMMIT_SHORT_SHA}}",
          "description": "Package built from ${CI_PROJECT_NAME}",
          "type": "library"
      }
      EOF
      fi
    # Create the package archive
    - mkdir -p package
    - cp -r src composer.json package/
    - cd package && zip -r ../${CI_PROJECT_NAME}-${CI_COMMIT_TAG:-${CI_COMMIT_SHORT_SHA}}.zip .
    - cd ..
  artifacts:
    paths:
      - ${CI_PROJECT_NAME}-${CI_COMMIT_TAG:-${CI_COMMIT_SHORT_SHA}}.zip
    expire_in: 1 hour

publish:nexus:
  stage: publish
  image: curlimages/curl:latest
  dependencies:
    - build:package
  script:
    - |
      PACKAGE_FILE="${CI_PROJECT_NAME}-${CI_COMMIT_TAG:-${CI_COMMIT_SHORT_SHA}}.zip"

      # Upload to Nexus Repository
      curl -u "${NEXUS_USER}:${NEXUS_PASSWORD}" \
        -F "asset=@${PACKAGE_FILE};type=application/zip" \
        "${NEXUS_URL}/service/rest/v1/components?repository=${NEXUS_REPO}"

      echo "Package uploaded successfully to ${NEXUS_REPO}"
  rules:
    - if: $CI_COMMIT_TAG
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
  environment:
    name: nexus
    url: ${NEXUS_URL}/repository/${NEXUS_REPO}

Configure the following GitLab CI/CD variables: