Building a Laravel Translation Package –Launching the Package

Published on by

Building a Laravel Translation Package –Launching the Package image

With the pre-launch checklist completed, it’s time to go ahead and make our package available for others to use.

Chances are, the consumers of the package will be using Composer to manage the dependencies in their project. To make the package compatible with composer, there are a few steps we need to follow.

Tagging a Release

To allow our users to manage their dependencies effectively, it’s important to properly release new versions of the package.

The most common approach to versioning code is to follow Semantic Versioning. This defines a set of ‘rules and requirements that dictate how version numbers are assigned and incremented’. From the website, these are defined as:

  1. MAJOR version when you make incompatible API changes,
  2. MINOR version when you add functionality in a backwards-compatible manner, and
  3. PATCH version when you make backwards-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

If you are interested, the full definition can be found on the website.

Deciding which version to tag your initial release can be tricky and I recently saw an interesting thread on Twitter discussing the issue.

Semantic Versioning suggest if you are are using the package in production, you should you go straight to 1.0.0, but if not and the package is still in development, the initial release should be 0.1.0.

There is more than one way to tag a release. For the purposes of this article, I’m going to show you how to do so on GitHub.

From the root of your repository, click on ‘Releases’ followed by ‘Draft a new release’.

There, enter your desired version number in the ‘Tag version’ field and select the target you want to reference. This can be a branch or an individual commit. If you wish, you can also provide an appropriate title for which, typically, I use the version number.

You can also provide release notes, which can be a nice way to let you users know exactly what has changed and maybe even thank your contributors.

Submitting to Packagist

Now, to allow users to easily install the package using Composer, it’s common to publish it to Packagist.

To do this, login to your Packagist account and click ‘Submit’ in the main navigation. Enter the URL of your git repository when prompted.

Packagist will pull in all the relevant information from the composer.json file and publish the package to the repository, ready for people to use. The package will now have its own page on the site providing users with details such as the number of installations, versions and latest activity.

Summary

With the package published and ready for people to use, we are at the end of this series of articles.

We now move in to business as usual, releasing new versions of the package and dealing with issues and pull requests submitted from the users.

I really hoped you enjoyed this series and have picked up some useful tips along the way. As usual, should you have any questions or comments, please send them across on Twitter.

Joe Dixon photo

Founder and CTO of ubisend. Proud Father to two tiny heroes, Husband, developer, occasional globetrotter.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
Cut PHP Code Review Time & Bugs into Half with CodeRabbit logo

Cut PHP Code Review Time & Bugs into Half with CodeRabbit

CodeRabbit is an AI-powered code review tool that specializes in PHP and Laravel, running PHPStan and offering automated PR analysis, security checks, and custom review features while remaining free for open-source projects.

Cut PHP Code Review Time & Bugs into Half with CodeRabbit
Join the Mastering Laravel community logo

Join the Mastering Laravel community

Connect with experienced developers in a friendly, noise-free environment. Get insights, share ideas, and find support for your coding challenges. Join us today and elevate your Laravel skills!

Join the Mastering Laravel community
Laravel Idea for PhpStorm logo

Laravel Idea for PhpStorm

Ultimate PhpStorm plugin for Laravel developers, delivering lightning-fast code completion, intelligent navigation, and powerful generation tools to supercharge productivity.

Laravel Idea for PhpStorm
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
MongoDB logo

MongoDB

Enhance your PHP applications with the powerful integration of MongoDB and Laravel, empowering developers to build applications with ease and efficiency. Support transactional, search, analytics and mobile use cases while using the familiar Eloquent APIs. Discover how MongoDB's flexible, modern database can transform your Laravel applications.

MongoDB

The latest

View all →
Handling Request Data Presence in Laravel image

Handling Request Data Presence in Laravel

Read article
First Factor One-Time Passwords for Laravel with OTPZ image

First Factor One-Time Passwords for Laravel with OTPZ

Read article
Managing Request Host Information in Laravel image

Managing Request Host Information in Laravel

Read article
Tim Leland: URL Shorteners, browser extensions, and more image

Tim Leland: URL Shorteners, browser extensions, and more

Read article
HTTP Method Verification in Laravel image

HTTP Method Verification in Laravel

Read article
Packistry is a Self-hosted Composer Repository Made with Laravel image

Packistry is a Self-hosted Composer Repository Made with Laravel

Read article