Skip to navigation
GeneratorsPHP

Publishing to Packagist

View as Markdown
Enterprise feature

This feature is available only for the Enterprise plan. To get started, reach out to support@buildwithfern.com.

Publish your public-facing Fern PHP SDK to the Packagist registry. After following the steps on this page, you’ll have a versioned package published on Packagist. To distribute the SDK internally instead, generate to the local file system (optionally self-hosted) and build a Composer archive with fern generate --package.

This page assumes that you have:

  • An initialized fern folder, a GitHub repository for your PHP SDK, and a PHP generator group in generators.yml. See Generating an SDK (PHP).
Versioned package published on Packagist

Configure generators.yml

1

Add repository location

PHP publishes via Git repositories, so remove the auto-generated output, location, and path fields. Instead, add the path to your GitHub repository:

groups: 
  php-sdk:
    generators:
      - name: fern-php-sdk
        version: 4.23.2
        github: 
          repository: your-org/company-php

Set up Packagist publishing authentication

1

Log into Packagist

Log into Packagist or create an account with Packagist.

2

Submit the Repository URL

  1. Click Submit.
  2. Input the full URL of the repository where you generated your PHP SDK, then click Check.
  3. Fix any errors Packagist finds in your repository, then click Submit.
Submit Package Screen in Packagist
3

Configure the GitHub Hook

Once you’ve submitted your URL, you’ll be prompted to set up the GitHub Hook.

  1. In to your repository, go to Settings > Webhooks.
  2. Select “Add webhook”
  3. Set the Payload URL as https://packagist.org/api/github?username=<your.packagist.username>
  4. Set the content type as application/json
  5. Packagist autogenerates API Tokens. To find yours, go to your Profile. Then, add your token to the Secret field.
  6. Set the trigger events as Just the push event
  7. Click “Add Webhook”
GitHub Webhook for Packagist

Release your SDK to Packagist

At this point, you’re ready to regenerate your SDK and publish it on Packagist:

fern generate --group php-sdk --version <version>

Local machine output will verify that the release is pushed to your repository and tagged with the version you specified. Log back into Packagist, click on your username, and select My packages to see your new release.