{"id":17024656,"url":"https://github.com/michael-rubel/artisan-release-command","last_synced_at":"2025-03-22T17:31:07.151Z","repository":{"id":187222079,"uuid":"676501075","full_name":"michael-rubel/artisan-release-command","owner":"michael-rubel","description":"An opinionated release process with Laravel Artisan Console.","archived":false,"fork":false,"pushed_at":"2025-03-05T23:08:46.000Z","size":413,"stargazers_count":16,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-18T13:51:16.483Z","etag":null,"topics":["artisan","artisan-command","laravel","looking-for-contributors","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/michael-rubel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["https://paypal.com/donate/?hosted_button_id=KHLEL8PFS4AXJ"]}},"created_at":"2023-08-09T10:45:09.000Z","updated_at":"2024-11-21T20:50:07.000Z","dependencies_parsed_at":"2023-08-09T13:13:43.973Z","dependency_job_id":"8be3b3e9-417a-4dfd-b30e-408f4e37b8ef","html_url":"https://github.com/michael-rubel/artisan-release-command","commit_stats":null,"previous_names":["michael-rubel/artisan-release-command"],"tags_count":4,"template":false,"template_full_name":"michael-rubel/laravel-package-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michael-rubel%2Fartisan-release-command","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michael-rubel%2Fartisan-release-command/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michael-rubel%2Fartisan-release-command/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michael-rubel%2Fartisan-release-command/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michael-rubel","download_url":"https://codeload.github.com/michael-rubel/artisan-release-command/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244994974,"owners_count":20544254,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["artisan","artisan-command","laravel","looking-for-contributors","php"],"created_at":"2024-10-14T07:26:29.721Z","updated_at":"2025-03-22T17:31:06.808Z","avatar_url":"https://github.com/michael-rubel.png","language":"PHP","funding_links":["https://paypal.com/donate/?hosted_button_id=KHLEL8PFS4AXJ"],"categories":[],"sub_categories":[],"readme":"# Artisan Release Command\n[![tests](https://github.com/michael-rubel/artisan-release-command/actions/workflows/tests.yml/badge.svg)](https://github.com/michael-rubel/artisan-release-command/actions/workflows/tests.yml)\n[![infection](https://github.com/michael-rubel/artisan-release-command/actions/workflows/infection.yml/badge.svg)](https://github.com/michael-rubel/artisan-release-command/actions/workflows/infection.yml)\n[![backward-compat](https://github.com/michael-rubel/artisan-release-command/actions/workflows/backward-compat.yml/badge.svg)](https://github.com/michael-rubel/artisan-release-command/actions/workflows/backward-compat.yml)\n[![phpstan](https://github.com/michael-rubel/artisan-release-command/actions/workflows/phpstan.yml/badge.svg)](https://github.com/michael-rubel/artisan-release-command/actions/workflows/phpstan.yml)\n\nArtisan command to create a GitHub release of your code.\n\n### Prerequisites\n\n- GitHub Actions\n- GitHub CLI\n- Access to a version file (Linux permissions).\n\n---\n\nThe package requires PHP `8.1` or higher and Laravel `10.8` or higher.\n\n## #StandWithUkraine\n[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)\n\n## Installation\nInstall the package using composer:\n```bash\ncomposer require michael-rubel/artisan-release-command --dev\n```\n\nPublish the config if you need to customize the command:\n```bash\nphp artisan vendor:publish --tag=\"artisan-release-command-config\"\n```\n\n## Usage\nSetup the GitHub Actions workflow trigger with the following parameters:\n\n```yaml\non:\n  push:\n    tags:\n      - '[0-9]+.[0-9]+.[0-9]+'\n```\n\nOr alternatively:\n```yaml\non:\n  release:\n    types:\n      - created\n```\n\nCreate a versioning file, for example:\n```php\n\u003c?php\n\nnamespace App;\n\nabstract class Service\n{\n    /**\n     * App version.\n     */\n    final public const VERSION = '0.0.1';\n}\n```\n\nNote: the version file should always contain a `VERSION` constant for the command to work. You can configure the constant name in the configuration file if you want to name it for example \"APP_VERSION\"\n\nThe command will bump version based on the [SemVer 2.0](https://semver.org/) type you'll provide.\n\n```php\nphp artisan release {type}\n```\n\nIt will pick the latest release you have in the versioning file, bump it a step further and push the change to the remote repository using your current Git setup. Make sure you're authorized to perform basic operations on your repository.\n\n### For example:\n```php\nphp artisan release major\n```\n\nAvailable options: `major`, `minor`, `patch`\n\nDefault value: `patch`\n\nAfter the version is pushed, it will create a release using GitHub CLI and provide auto-generated notes.\n\n### Beta release\n\nCreates the pre-release based on the given version type:\n\n```php\nphp artisan release major --beta\n```\n\nIf you had 0.0.1 in your version file, after this command it will be 1.0.0-beta, and the release will be marked as \"pre-release\" on GitHub (deployment won't be triggered if you use `[0-9]+.[0-9]+.[0-9]+` pattern in GitHub Actions).\n\n## Testing\n```bash\ncomposer test\n```\n\n## License\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichael-rubel%2Fartisan-release-command","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichael-rubel%2Fartisan-release-command","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichael-rubel%2Fartisan-release-command/lists"}