Skip to content

Commit

Permalink
Merge pull request #21 from dsbilling/release-1.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dsbilling committed May 21, 2024
2 parents 6cae6dc + 20d3131 commit 757c292
Show file tree
Hide file tree
Showing 9 changed files with 121 additions and 18 deletions.
6 changes: 3 additions & 3 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
; This file is for unifying the coding style for different editors and IDEs.
; More information at http://editorconfig.org

root = true

[*]
Expand All @@ -13,3 +10,6 @@ trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[*.{yml,yaml}]
indent_size = 2
12 changes: 10 additions & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,18 @@
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html

# Ignore all test and documentation with "export-ignore".
/.github export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/.travis.yml export-ignore
/phpunit.xml.dist export-ignore
/.scrutinizer.yml export-ignore
/art export-ignore
/docs export-ignore
/tests export-ignore
/.editorconfig export-ignore
/.php_cs.dist.php export-ignore
/psalm.xml export-ignore
/psalm.xml.dist export-ignore
/testbench.yaml export-ignore
/UPGRADING.md export-ignore
/phpstan.neon.dist export-ignore
/phpstan-baseline.neon export-ignore
12 changes: 12 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Please see the documentation for all configuration options:
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
labels:
- "dependencies"
32 changes: 32 additions & 0 deletions .github/workflows/dependabot-auto-merge.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: dependabot-auto-merge
on: pull_request_target

permissions:
pull-requests: write
contents: write

jobs:
dependabot:
runs-on: ubuntu-latest
if: ${{ github.actor == 'dependabot[bot]' }}
steps:

- name: Dependabot metadata
id: metadata
uses: dependabot/fetch-metadata@v2
with:
github-token: "${{ secrets.GITHUB_TOKEN }}"

- name: Auto-merge Dependabot PRs for semver-minor updates
if: ${{steps.metadata.outputs.update-type == 'version-update:semver-minor'}}
run: gh pr merge --auto --merge "$PR_URL"
env:
PR_URL: ${{github.event.pull_request.html_url}}
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

- name: Auto-merge Dependabot PRs for semver-patch updates
if: ${{steps.metadata.outputs.update-type == 'version-update:semver-patch'}}
run: gh pr merge --auto --merge "$PR_URL"
env:
PR_URL: ${{github.event.pull_request.html_url}}
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
28 changes: 28 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: "Release"

on:
release:
types: [released]

jobs:
update:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4
with:
ref: main

- name: Update Changelog
uses: stefanzweifel/changelog-updater-action@v1
with:
latest-version: ${{ github.event.release.name }}
release-notes: ${{ github.event.release.body }}

- name: Commit updated CHANGELOG
uses: stefanzweifel/git-auto-commit-action@v5
with:
branch: main
commit_message: Update CHANGELOG
file_pattern: CHANGELOG.md
11 changes: 10 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
.idea
.php_cs
.php_cs.cache
.phpunit.result.cache
build
composer.lock
coverage
docs
phpunit.xml
phpstan.neon
testbench.yaml
vendor
coverage
node_modules
.php-cs-fixer.cache
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,20 @@ composer require beyondcode/laravel-favicon

The service provider for this package will be automatically registered for you.

### Compatibility

| | 1.0 | 1.1 | 1.2 | 1.3 | 1.4 | 1.5 | 1.6 |
|-------|-----|-----|-----|-----|-----|-----|-----|
| 5.6.x ||||||||
| 5.7.x ||||||||
| 5.8.x ||||||||
| 6.x ||||||||
| 7.x ||||||||
| 8.x ||||||||
| 9.x ||||||||
| 10.x ||||||||
| 11.x ||||||||

## Usage

To make use of this package, make use of the `favicon` helper function that this package provides.
Expand All @@ -37,7 +51,7 @@ You can simply wrap the function around your favicon icon names, like this:
<link rel="shortcut icon" href="{{ favicon('favicon.ico') }}" />
```

## Customization
### Customization

You can completely customize which environments you want to have enabled for the favicon generation, as well as the font and colors that will be used.

Expand Down Expand Up @@ -87,7 +101,7 @@ return [
/*
* Intervention Image supports "GD Library" and "Imagick" to process images
* internally. You may choose one of them according to your PHP
* configuration. By default PHP's "GD Library" implementation is used.
* configuration. By default, PHP's "GD Library" implementation is used.
*
* If you want to convert ICO files, you need to use imagick.
*
Expand Down Expand Up @@ -136,23 +150,23 @@ The `shouldGenerateFavicon` method can be used to determine if a custom favicon

## FAQ

- My ICO files are not working, why?
### My ICO files are not working, why?

In order to modify ICO files, you need the Imagick PHP library installed and enabled in your `config/favicon.php` file.

- Is there a performance impact when I'm using this package?
### Is there a performance impact when I'm using this package?

No - the default generator only modifies your favicon when the specified environment is enabled. This means, that production environments only see the static assets that you already have.

### Changelog
## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

### Security
## Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Expand Down
10 changes: 5 additions & 5 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@
}
],
"require": {
"php": "^7.1|^8.0|^8.1|^8.2",
"illuminate/http": "5.6.*|5.7.*|5.8.*|6.*|7.*|8.*|9.*|^10.0",
"illuminate/support": "5.6.*|5.7.*|5.8.*|6.*|7.*|8.*|9.*|^10.0",
"php": "^7.1|^8.0|^8.1|^8.2|^8.3",
"illuminate/http": "5.6.*|5.7.*|5.8.*|6.*|7.*|8.*|9.*|^10.0|^11.0",
"illuminate/support": "5.6.*|5.7.*|5.8.*|6.*|7.*|8.*|9.*|^10.0|^11.0",
"intervention/image": "^2.4"
},
"require-dev": {
"phpunit/phpunit": "^7.0|^8.0|^9.0",
"orchestra/testbench": "^3.7|^4.0|^5.0|^6.0|^7.0"
"phpunit/phpunit": "^7.0|^8.0|^9.0|^10.0|^11.0",
"orchestra/testbench": "^3.7|^4.0|^5.0|^6.0|^7.0|^8.0|^9.0"
},
"autoload": {
"psr-4": {
Expand Down
2 changes: 1 addition & 1 deletion config/favicon.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
/*
* Intervention Image supports "GD Library" and "Imagick" to process images
* internally. You may choose one of them according to your PHP
* configuration. By default PHP's "GD Library" implementation is used.
* configuration. By default, PHP's "GD Library" implementation is used.
*
* If you want to convert ICO files, you need to use imagick.
*
Expand Down

0 comments on commit 757c292

Please sign in to comment.