Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Updater package #43

Merged
merged 4 commits into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .php-cs-fixer.cache

Large diffs are not rendered by default.

41 changes: 40 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Welcome to the Laravel Starter Project! This repository provides a kickstart set

## Table of Contents

- [# Laravel Starter Project (Version 11)](#-laravel-starter-project-version-11)
- [# Laravel-11 Starter Project](#-laravel-11-starter-project)
- [Table of Contents](#table-of-contents)
- [Uses Packages](#uses-packages)
- [Dashboard Template](#dashboard-template)
Expand All @@ -16,6 +16,11 @@ Welcome to the Laravel Starter Project! This repository provides a kickstart set
- [Deploy via FTP with CI/CD](#deploy-via-ftp-with-cicd)
- [GitFlow for Merge Requests](#gitflow-for-merge-requests)
- [FTP Deployment Process](#ftp-deployment-process)
- [Update Project](#update-project)
- [Laravel Auto Updater](#laravel-auto-updater)
- [Features](#features-1)
- [Usage](#usage)
- [Error Handling](#error-handling)
- [Contribution Guide](#contribution-guide)
- [License](#license)

Expand Down Expand Up @@ -185,6 +190,40 @@ To deploy your project:

2. Upon merging into the `master` branch, GitHub Actions automates deployment to your specified FTP server.

## Update Project
Here's the section specifically for the Laravel Auto Updater, which you can add to your README:

## Laravel Auto Updater

The Laravel Auto Updater feature enables seamless updates to your Laravel application, allowing you to manage and deploy updates effortlessly. Here’s how to use it:

### Features

- Automatically checks for updates.
- Initiates updates with simple Artisan commands.

### Usage

1. **Check for Updates:**
Run the following command to check for available updates.

```bash
php artisan update:check
```

2. **Initiate Update:**
Use the following command to initiate the update process.

```bash
php artisan update:initiate {version?}
```

Replace `{version?}` with a specific version number if desired; otherwise, it will initiate the update for the latest version.

### Error Handling

Ensure to handle any potential errors during the update process gracefully. Implement logging to monitor any issues that arise during updates.

## Contribution Guide

For guidelines on contributing to this project, refer to the [Contribution Guide](https://github.com/anisaronno/laravel-starter/blob/develop/CONTRIBUTING.md).
Expand Down
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "anisaronno/laravel-starter",
"type": "project",
"version": "0.3.0",
"version": "0.3.1",
"description": "A perfect laravel starter project for any kind of project.",
"keywords": [
"laravel",
Expand All @@ -19,6 +19,7 @@
],
"require": {
"php": "^8.2",
"anisaronno/laravel-auto-updater": "^1.0",
"anisaronno/laravel-media-gallery": "0.6.0",
"anisaronno/laravel-settings": "^1.2.0",
"guzzlehttp/guzzle": "^7.2",
Expand Down
63 changes: 62 additions & 1 deletion composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions config/auto-updater-config.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?php

return [
'github_url' => 'https://api.github.com/repos/anisAronno/laravel-starter/releases',
'custom_url' => 'https://laravel-starter.test/api/release',
'source' => env('UPDATE_SOURCE', 'github'), // 'github' or 'custom'
];
Loading