Skip to content

Commit

Permalink
MNT Standardise modules
Browse files Browse the repository at this point in the history
  • Loading branch information
emteknetnz committed Aug 2, 2022
1 parent 6c93e59 commit eeac245
Show file tree
Hide file tree
Showing 8 changed files with 44 additions and 38 deletions.
1 change: 0 additions & 1 deletion .codecov.yml

This file was deleted.

16 changes: 16 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: CI

on:
push:
pull_request:
workflow_dispatch:
# Every Sunday at 4:10pm UTC
schedule:
- cron: '10 16 * * 0'

jobs:
ci:
name: CI
# Only run cron on the bringyourownideas account
if: (github.event_name == 'schedule' && github.repository_owner == 'bringyourownideas') || (github.event_name != 'schedule')
uses: silverstripe/gha-ci/.github/workflows/ci.yml@v1
17 changes: 17 additions & 0 deletions .github/workflows/keepalive.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Keepalive

on:
workflow_dispatch:
# The 8th of every month at 4:50pm UTC
schedule:
- cron: '50 16 8 * *'

jobs:
keepalive:
name: Keepalive
# Only run cron on the bringyourownideas account
if: (github.event_name == 'schedule' && github.repository_owner == 'bringyourownideas') || (github.event_name != 'schedule')
runs-on: ubuntu-latest
steps:
- name: Keepalive
uses: silverstripe/gha-keepalive@v1
9 changes: 0 additions & 9 deletions .github/workflows/main.yml

This file was deleted.

15 changes: 0 additions & 15 deletions .scrutinizer.yml

This file was deleted.

20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,13 @@
# SilverStripe Composer update checker
# Silverstripe Composer update checker

[![Build Status](https://api.travis-ci.org/bringyourownideas/silverstripe-composer-update-checker.svg?branch=master)](https://travis-ci.org/bringyourownideas/silverstripe-composer-update-checker)
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/bringyourownideas/silverstripe-composer-update-checker.svg)](https://scrutinizer-ci.com/g/bringyourownideas/silverstripe-composer-update-checker?branch=master)
[![codecov](https://codecov.io/gh/bringyourownideas/silverstripe-composer-update-checker/branch/master/graph/badge.svg)](https://codecov.io/gh/bringyourownideas/silverstripe-composer-update-checker)
[![SilverStripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
[![Latest Stable Version](https://poser.pugx.org/bringyourownideas/silverstripe-composer-update-checker/version.svg)](https://github.com/bringyourownideas/silverstripe-composer-update-checker/releases)
[![Latest Unstable Version](https://poser.pugx.org/bringyourownideas/silverstripe-composer-update-checker/v/unstable.svg)](https://packagist.org/packages/bringyourownideas/silverstripe-composer-update-checker)
[![Total Downloads](https://poser.pugx.org/bringyourownideas/silverstripe-composer-update-checker/downloads.svg)](https://packagist.org/packages/bringyourownideas/silverstripe-composer-update-checker)
[![License](https://poser.pugx.org/bringyourownideas/silverstripe-composer-update-checker/license.svg)](https://github.com/bringyourownideas/silverstripe-composer-update-checker/blob/master/license.md)
[![CI](https://github.com/bringyourownideas/silverstripe-composer-update-checker/actions/workflows/ci.yml/badge.svg)](https://github.com/bringyourownideas/silverstripe-composer-update-checker/actions/workflows/ci.yml)
[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)

Checks if any of your Composer dependencies needs to be updated, and tracks the available and latest versions that can
be updated to.

This module only runs the actual checks and saves the information into fields on the Package DataObject. The fields
are also added to the report that the [SilverStripe Maintenance module](https://github.com/bringyourownideas/silverstripe-maintenance)
are also added to the report that the [Silverstripe Maintenance module](https://github.com/bringyourownideas/silverstripe-maintenance)
provides.

The bulk of the heavy lifting here is done using the Composer PHP API, which mimics the behaviour of using Composer on
Expand All @@ -27,8 +21,8 @@ the command line to install or update PHP packages.

#### Compatibility

The 1.x release line of this module is compatible with SilverStripe ^3.2, and the 2.x release line is compatible with
SilverStripe ^4.0.
The 1.x release line of this module is compatible with Silverstripe ^3.2, and the 2.x release line is compatible with
Silverstripe ^4.0.

The 2.x release line of the module is compatible with composer v1, and this 3.x release line is
compatible with composer v2
Expand Down Expand Up @@ -58,7 +52,7 @@ updates to private repositories.

## Documentation

Please see the user guide section of the [SilverStripe Maintenance module](https://github.com/bringyourownideas/silverstripe-maintenance/tree/master/docs/en/userguide).
Please see the user guide section of the [Silverstripe Maintenance module](https://github.com/bringyourownideas/silverstripe-maintenance/tree/master/docs/en/userguide).

### Terminology

Expand Down
3 changes: 3 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@
"phpunit/phpunit": "^9.5",
"squizlabs/php_codesniffer": "^3"
},
"conflict": {
"symbiote/silverstripe-queuedjobs": "<4.1.0"
},
"autoload": {
"psr-4": {
"BringYourOwnIdeas\\UpdateChecker\\": "src/",
Expand Down
1 change: 1 addition & 0 deletions phpunit.xml.dist
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true">
<testsuite name="Default">
<directory>tests/</directory>
Expand Down

0 comments on commit eeac245

Please sign in to comment.