generated from ergebnis/php-package-template
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit f5f3b65
Showing
32 changed files
with
9,136 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
end_of_line = lf | ||
indent_size = 4 | ||
indent_style = space | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
[*.json] | ||
indent_size = 2 | ||
|
||
[*.md] | ||
indent_size = 2 | ||
|
||
[*.{yaml,yml}] | ||
indent_size = 2 | ||
|
||
[Makefile] | ||
indent_style = tab |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
/.github/ export-ignore | ||
/.phive/ export-ignore | ||
/test/ export-ignore | ||
/.editorconfig export-ignore | ||
/.gitattributes export-ignore | ||
/.gitignore export-ignore | ||
/.php-cs-fixer.php export-ignore | ||
/.yamllint.yaml export-ignore | ||
/composer-require-checker.json export-ignore | ||
/composer.lock export-ignore | ||
/infection.json export-ignore | ||
/Makefile export-ignore | ||
/psalm-baseline.xml export-ignore | ||
/psalm.xml export-ignore | ||
/rector.php export-ignore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners | ||
|
||
* @ergebnis-bot @localheinz |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,151 @@ | ||
# CONTRIBUTING | ||
|
||
We use [GitHub Actions](https://github.com/features/actions) as a continuous integration system. | ||
|
||
For details, take a look at the following workflow configuration files: | ||
|
||
- [`workflows/integrate.yaml`](workflows/integrate.yaml) | ||
- [`workflows/merge.yaml`](workflows/merge.yaml) | ||
- [`workflows/release.yaml`](workflows/release.yaml) | ||
- [`workflows/renew.yaml`](workflows/renew.yaml) | ||
- [`workflows/triage.yaml`](workflows/triage.yaml) | ||
|
||
## Backward-Compatibility Analysis | ||
|
||
We use [`roave/backward-compatibility-check`](https://github.com/Roave/BackwardCompatibilityCheck) to prevent breaking backwards-compatibility. | ||
|
||
Run | ||
|
||
```sh | ||
make backward-compatibility-analysis | ||
``` | ||
|
||
to run a backward-compatibility analysis. | ||
|
||
## Coding Standards | ||
|
||
We use [`ergebnis/composer-normalize`](https://github.com/ergebnis/composer-normalize) to normalize `composer.json`. | ||
|
||
We use [`yamllint`](https://github.com/adrienverge/yamllint) to enforce coding standards in YAML files. | ||
|
||
If you do not have `yamllint` installed yet, run | ||
|
||
```sh | ||
brew install yamllint | ||
``` | ||
|
||
to install `yamllint`. | ||
|
||
We use [`friendsofphp/php-cs-fixer`](https://github.com/FriendsOfPHP/PHP-CS-Fixer) to enforce coding standards in PHP files. | ||
|
||
Run | ||
|
||
```sh | ||
make coding-standards | ||
``` | ||
|
||
to automatically fix coding standard violations. | ||
|
||
## Dependency Analysis | ||
|
||
We use [`maglnet/composer-require-checker`](https://github.com/maglnet/ComposerRequireChecker) to prevent the use of unknown symbols in production code. | ||
|
||
Run | ||
|
||
```sh | ||
make dependency-analysis | ||
``` | ||
|
||
to run a dependency analysis. | ||
|
||
## Mutation Tests | ||
|
||
We use [`infection/infection`](https://github.com/infection/infection) to ensure a minimum quality of the tests. | ||
|
||
Enable `Xdebug` and run | ||
|
||
```sh | ||
make mutation-tests | ||
``` | ||
|
||
to run mutation tests. | ||
|
||
## Refactoring | ||
|
||
We use [`rector/rector`](https://github.com/rectorphp/rector) to automatically refactor code. | ||
|
||
Run | ||
|
||
```sh | ||
make refactoring | ||
``` | ||
|
||
to automatically refactor code. | ||
|
||
## Security Analysis | ||
|
||
We use [`composer`](https://github.com/composer/composer) to run a security analysis. | ||
|
||
Run | ||
|
||
```sh | ||
make security-analysis | ||
``` | ||
|
||
to run a security analysis. | ||
|
||
## Static Code Analysis | ||
|
||
We use [`vimeo/psalm`](https://github.com/vimeo/psalm) to statically analyze the code. | ||
|
||
Run | ||
|
||
```sh | ||
make static-code-analysis | ||
``` | ||
|
||
to run a static code analysis. | ||
|
||
We also use the baseline feature of [`vimeo/psalm`](https://psalm.dev/docs/running_psalm/dealing_with_code_issues/#using-a-baseline-file). | ||
|
||
Run | ||
|
||
```sh | ||
make static-code-analysis-baseline | ||
``` | ||
|
||
to regenerate the baseline in [`../psalm-baseline.xml`](../psalm-baseline.xml). | ||
|
||
:exclamation: Ideally, the baseline should shrink over time. | ||
|
||
## Tests | ||
|
||
We use [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit) to drive the development. | ||
|
||
Run | ||
|
||
```sh | ||
make tests | ||
``` | ||
|
||
to run all the tests. | ||
|
||
## Extra lazy? | ||
|
||
Run | ||
|
||
```sh | ||
make | ||
``` | ||
|
||
to automatically refactor code, enforce coding standards, run a static code analysis, and run tests! | ||
|
||
## Help | ||
|
||
:bulb: Run | ||
|
||
```sh | ||
make help | ||
``` | ||
|
||
to display a list of available targets with corresponding descriptions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Security Policy | ||
|
||
## Supported Versions | ||
|
||
The following versions of `ergebnis/version-constraint` have active support: | ||
|
||
- `x.y.z` | ||
|
||
## Unsupported Versions | ||
|
||
The following versions of `ergebnis/version-constraint` have reached their end of life: | ||
|
||
- `x.y.z` | ||
|
||
## Reporting a Vulnerability | ||
|
||
If you believe that you have found a security vulnerability, please send an email to `[email protected]`. Ensure to include all details required to understand the severity of the issue. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file | ||
|
||
version: 2 | ||
|
||
updates: | ||
- allow: | ||
- dependency-type: "development" | ||
commit-message: | ||
include: "scope" | ||
prefix: "composer" | ||
directory: "/" | ||
labels: | ||
- "dependency" | ||
open-pull-requests-limit: 10 | ||
package-ecosystem: "composer" | ||
schedule: | ||
interval: "daily" | ||
versioning-strategy: "increase" | ||
|
||
- commit-message: | ||
include: "scope" | ||
prefix: "github-actions" | ||
directory: "/" | ||
labels: | ||
- "dependency" | ||
open-pull-requests-limit: 10 | ||
package-ecosystem: "github-actions" | ||
schedule: | ||
interval: "daily" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes | ||
|
||
changelog: | ||
exclude: | ||
authors: | ||
- "dependabot" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
# https://github.com/repository-settings/app | ||
|
||
branches: | ||
- name: "main" | ||
|
||
# https://docs.github.com/en/rest/reference/repos#delete-branch-protection | ||
# https://docs.github.com/en/rest/reference/repos#update-branch-protection | ||
|
||
protection: | ||
enforce_admins: false | ||
required_pull_request_reviews: | ||
dismiss_stale_reviews: true | ||
require_code_owner_reviews: true | ||
required_approving_review_count: 1 | ||
required_status_checks: | ||
checks: | ||
- context: "Backward-Compatibility Analysis (8.1, locked)" | ||
- context: "Code Coverage (8.1, locked)" | ||
- context: "Coding Standards (8.1, locked)" | ||
- context: "Dependency Analysis (8.1, locked)" | ||
- context: "Mutation Tests (8.1, locked)" | ||
- context: "Refactoring (8.1, locked)" | ||
- context: "Security Analysis (8.1, locked)" | ||
- context: "Static Code Analysis (8.1, locked)" | ||
- context: "Tests (8.1, highest)" | ||
- context: "Tests (8.1, locked)" | ||
- context: "Tests (8.1, lowest)" | ||
- context: "Tests (8.2, highest)" | ||
- context: "Tests (8.2, locked)" | ||
- context: "Tests (8.2, lowest)" | ||
- context: "Tests (8.3, highest)" | ||
- context: "Tests (8.3, locked)" | ||
- context: "Tests (8.3, lowest)" | ||
strict: false | ||
restrictions: | ||
|
||
# https://docs.github.com/en/rest/reference/repos#list-branches--parameters | ||
|
||
# Note: User, app, and team restrictions are only available for organization-owned repositories. | ||
# Set to null to disable when using this configuration for a repository on a personal account. | ||
|
||
apps: [] | ||
teams: [] | ||
users: | ||
- "ergebnis-bot" | ||
|
||
# https://docs.github.com/en/rest/reference/issues#create-a-label | ||
# https://docs.github.com/en/rest/reference/issues#update-a-label | ||
|
||
labels: | ||
- name: "bug" | ||
color: "ee0701" | ||
description: "" | ||
|
||
- name: "dependency" | ||
color: "0366d6" | ||
description: "" | ||
|
||
- name: "enhancement" | ||
color: "0e8a16" | ||
description: "" | ||
|
||
- name: "question" | ||
color: "cc317c" | ||
description: "" | ||
|
||
- name: "security" | ||
color: "ee0701" | ||
description: "" | ||
|
||
# https://docs.github.com/en/rest/reference/repos#update-a-repository | ||
|
||
repository: | ||
allow_merge_commit: true | ||
allow_rebase_merge: false | ||
allow_squash_merge: false | ||
archived: false | ||
default_branch: "main" | ||
delete_branch_on_merge: true | ||
description: "🎚️ Provides abstractions of version constraints." | ||
enable_automated_security_fixes: true | ||
enable_vulnerability_alerts: true | ||
has_discussions: false | ||
has_downloads: true | ||
has_issues: true | ||
has_pages: false | ||
has_projects: false | ||
has_wiki: false | ||
is_template: false | ||
name: "version-constraint" | ||
private: false | ||
|
||
# https://docs.github.com/en/rest/reference/repos#replace-all-repository-topics | ||
|
||
topics: "version, constraint" |
Oops, something went wrong.