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

Establish quality standards #27

Merged
merged 21 commits into from
Jul 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
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
12 changes: 6 additions & 6 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ root = true

[*]
charset = utf-8
indent_style = tab
indent_size = 4
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = tab
indent_size = 4

[{.jshintrc,*.json,*.yml}]
[*.md]
trim_trailing_whitespace = false

[{*.json,*.yml}]
indent_style = space
indent_size = 2

[{*.txt,wp-config-sample.php}]
end_of_line = crlf
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,11 @@ updates:
- dependency-type: "direct"
open-pull-requests-limit: 10

- package-ecosystem: github-actions
directory: "/"
schedule:
interval: weekly
open-pull-requests-limit: 10

# maybe interesting later
# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#composer-repository
13 changes: 13 additions & 0 deletions .github/workflows/build-test-measure.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Build, test & measure

on:
workflow_call:
pull_request:
push:
branches:
['main']

jobs:
call-workflow-build-test-measure:
uses: figuren-theater/code-quality/.github/workflows/build-test-measure.yml@main
secrets: inherit
10 changes: 10 additions & 0 deletions .github/workflows/ft-issue-gardening.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Issue gardening for figuren.theater

on:
issues:
types:
- opened
jobs:
call-workflow-ft-issue-gardening:
uses: figuren-theater/.github/.github/workflows/issue-gardening.yml@main
secrets: inherit
12 changes: 12 additions & 0 deletions .github/workflows/prerelease-changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: 'pre-Release Changelog Update'

on:
workflow_call:
release:
types: [prereleased]

jobs:
call-workflow-update-changelog:
uses: figuren-theater/.github/.github/workflows/prerelease-changelog-update.yml@main
secrets: inherit

19 changes: 19 additions & 0 deletions .github/workflows/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Draft or update the next release

on:
push:
# branches to consider in the event; optional, defaults to all
branches:
- main
# pull_request event is required only for autolabeler
pull_request:
# Only following types are handled by the action, but one can default to all as well
types: [opened, reopened, synchronize]
# pull_request_target event is required for autolabeler to support PRs from forks
# pull_request_target:
# types: [opened, reopened, synchronize]

jobs:
call-workflow-release-drafter:
uses: figuren-theater/.github/.github/workflows/release-drafter.yml@main
secrets: inherit
2 changes: 1 addition & 1 deletion .github/workflows/wp-cron-runner.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
steps:
- name: cURL request
# Hit the webhook endpoint to let WordPress do some routine jobs
#
#
# Add a job summary with the wp_die() output, the cron runner creates
# https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary
run: curl "https://figuren.theater/run-cron" >> $GITHUB_STEP_SUMMARY
7 changes: 5 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
.DS_Store
phpcs.xml
phpunit.xml
Thumbs.db
wp-cli.local.yml
node_modules/
Expand All @@ -9,3 +7,8 @@ node_modules/
*.zip

/vendor/

# is created during composer install,
# when package is tested
# and not running within ft-platform
/wp-content/
31 changes: 31 additions & 0 deletions .phpcs.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?xml version="1.0"?>
<ruleset name="ft-maintenance">
<description>Coding standards for ft-maintenance</description>

<file>.</file>

<!--
<exclude-pattern>*/bin/*</exclude-pattern>
<exclude-pattern>*/tests/*</exclude-pattern>
-->

<!--
is created during composer install,
when package is tested
and not running within ft-platform
-->
<exclude-pattern>*/wp-content/*</exclude-pattern>

<!-- Use figuren.theater Coding Standards -->
<rule ref="figurentheater" />

<!--
<rule ref="WordPress.WP.I18n">
<properties>
<property name="text_domain" type="array">
<element value="figurentheater"/>
</property>
</properties>
</rule> -->

</ruleset>
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Changelog

All notable changes to this project will be documented in this file.

## [Unreleased](https://github.com/figuren-theater/ft-maintenance/compare/1.0.15...HEAD)


46 changes: 21 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,37 +27,31 @@
This is the long desc

* [x] *list closed tracking-issues or `docs` files here*
* [ ] Do you have any [ideas](/issues/new) ?
* [ ] Do you have any [ideas](https://github.com/figuren-theater/ft-maintenance/issues/new) ?

## Background & Motivation

...

## Install

1. Add this repository and the *extra* to your `composer.json`
```json
"repositories": [
{
"type": "git",
"url": "https://github.com/figuren-theater/ft-maintenance"
}
]
"extra": {
"dropin-paths": {
"htdocs/wp-content/": [
"package:figuren-theater/ft-maintenance:templates/htdocs/wp-content/db-error.php",
"package:figuren-theater/ft-maintenance:templates/htdocs/wp-content/maintenance.php",
"package:figuren-theater/ft-maintenance:templates/htdocs/wp-content/php-error.php"
]
}
}
```
1. Add this *extra* to your `composer.json`
```json
"extra": {
"dropin-paths": {
"htdocs/wp-content/": [
"package:figuren-theater/ft-maintenance:templates/htdocs/wp-content/db-error.php",
"package:figuren-theater/ft-maintenance:templates/htdocs/wp-content/maintenance.php",
"package:figuren-theater/ft-maintenance:templates/htdocs/wp-content/php-error.php"
]
}
}
```

2. Install via command line
```sh
composer require figuren-theater/ft-maintenance
```
```sh
composer require figuren-theater/ft-maintenance
```

## Usage

Expand Down Expand Up @@ -93,6 +87,8 @@ Accompaniying the core functionality of the mentioned plugins, theese **best pra
## Built with & uses

- [dependabot](/.github/dependabot.yml)
- [code-quality](https://github.com/figuren-theater/code-quality/)
A set of status checks to ensure high and consitent code-quality for the figuren.theater platform.
- ....

## Contributing
Expand All @@ -112,18 +108,18 @@ Don't forget to give the project a star! Thanks again!
## Versioning

We use [Semantic Versioning](http://semver.org/) for versioning. For the versions
available, see the [tags on this repository](/tags).
available, see the [tags on this repository](https://github.com/figuren-theater/ft-maintenance/tags).

## Authors

- **Carsten Bach** - *Provided idea & code* - [figuren.theater/crew](https://figuren.theater/crew/)

See also the list of [contributors](/contributors)
See also the list of [contributors](https://github.com/figuren-theater/ft-maintenance/contributors)
who participated in this project.

## License

This project is licensed under the [GPL-3.0-or-later](LICENSE.md), see the [LICENSE](LICENSE) file for
This project is licensed under the **GPL-3.0-or-later**, see the [LICENSE](/LICENSE) file for
details

## Acknowledgments
Expand Down
Loading