https://github.com/hotaruma/packagist-sync

GitHub Action to automatically update package information on Packagist.
https://github.com/hotaruma/packagist-sync

api apimanagement github-actions packagist publishing

Last synced: 23 days ago
JSON representation

GitHub Action to automatically update package information on Packagist.

• Host: GitHub
• URL: https://github.com/hotaruma/packagist-sync
• Owner: hotaruma
• License: mit
• Created: 2023-06-21T06:20:44.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-30T21:40:28.000Z (about 2 years ago)
• Last Synced: 2025-06-08T05:09:25.782Z (25 days ago)
• Topics: api, apimanagement, github-actions, packagist, publishing
• Language: PHP
• Homepage:
• Size: 25.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Packagist Sync Action

[![Build and Test](https://github.com/hotaruma/packagist-sync/actions/workflows/test.yml/badge.svg)](https://github.com/hotaruma/packagist-sync/actions/workflows/test.yml)

[![License](https://img.shields.io/github/license/hotaruma/packagist-sync.svg)](https://github.com/hotaruma/packagist-sync/blob/master/LICENSE)

This action automates the synchronization and updating of package information on Packagist.

## Example usage

Minimal setup:

```yaml

uses: hotaruma/[email protected]

with:

  api-token: ${{ secrets.packagist_token }}

  # Optional Parameters

  packagist-username: 'username'

  package-name: 'vendor/package'

  github-repository-url: 'https://github.com/vendor/package'

  packagist-domain: 'https://packagist.org'

  composer-json-path: '/path/to/'

```

## Inputs

### `api-token`

**Required** - The API token for Packagist.

### `packagist-username`

The username on Packagist.

> This parameter is **optional** if the package name is set in the `composer.json` file. If the package name is set, the

> vendor part will be used as the username.

### `package-name`

The name of the package.

> This **parameter** is optional if the package name is already set in the `composer.json` file.

### `github-repository-url`

The URL of the GitHub repository.

> This parameter is optional if the package already exists.

### `packagist-domain`

**Optional** - The domain of Packagist.

### `composer-json-path`

**Optional** - The custom path to the `composer.json` file.

> The path should be relative to `$GITHUB_WORKSPACE`.