wessama/nova-bitbucket-pipelines

A Laravel Nova card for showing the status of the latest Bitbucket Pipelines build.

v1.0.0 2023-10-07 21:01 UTC

This package is auto-updated.

Last update: 2024-11-08 00:11:37 UTC


README

Latest Version on Packagist Total Downloads

Installation

You can install the package in a Laravel app that uses Nova via composer:

composer require wessama/nova-bitbucket-pipelines

Next up, you must register the card with Nova. This is typically done in the cards method of a Dashboard class.

public function cards()
{
    return [
        // ...
         (new \WessamA\NovaBitbucketPipelines\Pipelines()),
    ];
}

Configuration and Usage

Before using the package, you need to set up your environment variables and publish the configuration file to customize the package according to your needs.

Setting Environment Variables

  1. Open your .env file in the root of your Laravel project.

  2. Find and set the following environment variables related to the Bitbucket API:

    BITBUCKET_API_ROOT=https://api.bitbucket.org # Default API root URL (you may not need to change this)
    BITBUCKET_API_VERSION=2.0 # Default API version (you may not need to change this)
    BITBUCKET_APP_PASSWORD=your_app_password # Replace 'your_app_password' with your actual Bitbucket app password
    BITBUCKET_USERNAME=your_username # Replace 'your_username' with your actual Bitbucket username
    BITBUCKET_WORKSPACE_WEB_NAME=your_workspace_name # Replace with your workspace name
    BITBUCKET_WORKSPACE_WEB_REPO_NAME=your_repo_name # Replace with your repository name

Publishing the Configuration File

To publish the package’s configuration file to your application's config directory, run the following command:

php artisan vendor:publish --tag=config --provider="WessamA\NovaBitbucketPipelines\CardServiceProvider"

Changelog

Please see CHANGELOG for more information on what has changed recently.

Security

If you discover any security related issues, please email wessam.ah@outlook.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.