Skip to content

Commit

Permalink
Merge pull request #609 from ergebnis/feature/synchronize
Browse files Browse the repository at this point in the history
Enhancement: Synchronize with `ergebnis/php-package-template`
  • Loading branch information
localheinz committed Jun 30, 2023
2 parents 1c6b164 + 6cb44e7 commit 6311b0e
Show file tree
Hide file tree
Showing 33 changed files with 591 additions and 324 deletions.
4 changes: 2 additions & 2 deletions .editorconfig
Expand Up @@ -10,8 +10,8 @@ trim_trailing_whitespace = true
[*.json]
indent_size = 2

[*.neon]
indent_style = tab
[*.md]
indent_size = 2

[*.{yaml,yml}]
indent_size = 2
Expand Down
3 changes: 3 additions & 0 deletions .gitattributes
Expand Up @@ -5,8 +5,11 @@
/.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
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
@@ -1 +1,3 @@
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

* @ergebnis-bot @localheinz
45 changes: 34 additions & 11 deletions .github/CONTRIBUTING.md
Expand Up @@ -6,7 +6,6 @@ For details, take a look at the following workflow configuration files:

- [`workflows/integrate.yaml`](workflows/integrate.yaml)
- [`workflows/merge.yaml`](workflows/merge.yaml)
- [`workflows/prune.yaml`](workflows/prune.yaml)
- [`workflows/release.yaml`](workflows/release.yaml)
- [`workflows/renew.yaml`](workflows/renew.yaml)
- [`workflows/triage.yaml`](workflows/triage.yaml)
Expand All @@ -20,7 +19,7 @@ We are using [`yamllint`](https://github.com/adrienverge/yamllint) to enforce co
If you do not have `yamllint` installed yet, run

```sh
$ brew install yamllint
brew install yamllint
```

to install `yamllint`.
Expand All @@ -30,7 +29,7 @@ We are using [`friendsofphp/php-cs-fixer`](https://github.com/FriendsOfPHP/PHP-C
Run

```sh
$ make coding-standards
make coding-standards
```

to automatically fix coding standard violations.
Expand All @@ -42,7 +41,7 @@ We are using [`maglnet/composer-require-checker`](https://github.com/maglnet/Com
Run

```sh
$ make dependency-analysis
make dependency-analysis
```

to run a dependency analysis.
Expand All @@ -54,19 +53,43 @@ We are using [`infection/infection`](https://github.com/infection/infection) to
Enable `Xdebug` and run

```sh
$ make mutation-tests
make mutation-tests
```

to run mutation tests.

## Refactoring

We are using [`rector/rector`](https://github.com/rectorphp/rector) to automatically refactor code.

Run

```sh
make refactoring
```

to automatically refactor code.

## Security Analysis

We are using [`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 are using [`vimeo/psalm`](https://github.com/vimeo/psalm) to statically analyze the code.

Run

```sh
$ make static-code-analysis
make static-code-analysis
```

to run a static code analysis.
Expand All @@ -76,7 +99,7 @@ We are also using the baseline feature of [`vimeo/psalm`](https://psalm.dev/docs
Run

```sh
$ make static-code-analysis-baseline
make static-code-analysis-baseline
```

to regenerate the baseline in [`../psalm-baseline.xml`](../psalm-baseline.xml).
Expand All @@ -90,7 +113,7 @@ We are using [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit) t
Run

```sh
$ make tests
make tests
```

to run all the tests.
Expand All @@ -100,17 +123,17 @@ to run all the tests.
Run

```sh
$ make
make
```

to enforce coding standards, run a static code analysis, and run tests!
to automatically refactor code, enforce coding standards, run a static code analysis, and run tests!

## Help

:bulb: Run

```sh
$ make help
make help
```

to display a list of available targets with corresponding descriptions.
17 changes: 17 additions & 0 deletions .github/SECURITY.md
@@ -0,0 +1,17 @@
# Security Policy

## Supported Versions

The following versions of `ergebnis/clock` have active support:

- `^2.6.0`

## Unsupported Versions

The following versions of `ergebnis/clock` have reached their end of life:

- `<2.6.0`

## Reporting a Vulnerability

If you believe that you have found a security vulnerability, please send an email to `am@localheinz.com`. Ensure to include all details required to understand the severity of the issue.

This file was deleted.

22 changes: 0 additions & 22 deletions .github/actions/composer/composer/install/action.yaml

This file was deleted.

25 changes: 0 additions & 25 deletions .github/actions/composer/composer/install/run.sh

This file was deleted.

34 changes: 18 additions & 16 deletions .github/settings.yml
Expand Up @@ -13,18 +13,20 @@ branches:
require_code_owner_reviews: true
required_approving_review_count: 1
required_status_checks:
contexts:
- "Code Coverage (8.1, locked)"
- "Coding Standards (8.1, locked)"
- "Dependency Analysis (8.1, locked)"
- "Mutation Tests (8.1, locked)"
- "Static Code Analysis (8.1, locked)"
- "Tests (8.1, highest)"
- "Tests (8.1, locked)"
- "Tests (8.1, lowest)"
- "Tests (8.2, highest)"
- "Tests (8.2, locked)"
- "Tests (8.2, lowest)"
checks:
- 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)"
strict: false
restrictions:

Expand Down Expand Up @@ -62,10 +64,6 @@ labels:
color: "ee0701"
description: ""

- name: "stale"
color: "eeeeee"
description: ""

# https://docs.github.com/en/rest/reference/repos#update-a-repository

repository:
Expand All @@ -76,11 +74,15 @@ repository:
default_branch: "main"
delete_branch_on_merge: true
description: ":alarm_clock: Provides a simple abstraction of a clock."
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: "clock"
private: false

Expand Down

0 comments on commit 6311b0e

Please sign in to comment.