{"id":19847573,"url":"https://github.com/bringyourownideas/silverstripe-maintenance","last_synced_at":"2025-05-01T22:30:20.400Z","repository":{"id":41145735,"uuid":"42240917","full_name":"bringyourownideas/silverstripe-maintenance","owner":"bringyourownideas","description":"Helps with the day by day work to run a SilverStripe application or website.","archived":false,"fork":false,"pushed_at":"2025-04-30T23:26:27.000Z","size":1724,"stargazers_count":31,"open_issues_count":14,"forks_count":10,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-01T00:32:43.315Z","etag":null,"topics":["composer","maintenance","silverstripe","silverstripe-maintenance"],"latest_commit_sha":null,"homepage":"https://bringyourownideas.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bringyourownideas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-09-10T11:37:42.000Z","updated_at":"2025-03-27T02:39:26.000Z","dependencies_parsed_at":"2023-02-11T23:16:54.999Z","dependency_job_id":"91a65365-60c2-4c97-8e30-f294d052e0cc","html_url":"https://github.com/bringyourownideas/silverstripe-maintenance","commit_stats":{"total_commits":196,"total_committers":16,"mean_commits":12.25,"dds":0.6581632653061225,"last_synced_commit":"5cdb98d3e0cb05e59668b6b63d4b1dac8b18ff48"},"previous_names":[],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bringyourownideas%2Fsilverstripe-maintenance","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bringyourownideas%2Fsilverstripe-maintenance/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bringyourownideas%2Fsilverstripe-maintenance/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bringyourownideas%2Fsilverstripe-maintenance/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bringyourownideas","download_url":"https://codeload.github.com/bringyourownideas/silverstripe-maintenance/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251954623,"owners_count":21670842,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["composer","maintenance","silverstripe","silverstripe-maintenance"],"created_at":"2024-11-12T13:14:34.530Z","updated_at":"2025-05-01T22:30:19.547Z","avatar_url":"https://github.com/bringyourownideas.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Silverstripe Maintenance\n\n[![CI](https://github.com/bringyourownideas/silverstripe-maintenance/actions/workflows/ci.yml/badge.svg)](https://github.com/bringyourownideas/silverstripe-maintenance/actions/workflows/ci.yml)\n[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)\n\n## Overview\n\nThe [Silverstripe Maintenance module](https://github.com/bringyourownideas/silverstripe-maintenance \"Assists with the \nmaintenance of your Silverstripe application\") reduces your maintenance related work.\n\n![UI Preview](docs/en/_img/ui-with-sec-alert.png)\n\n## Requirements\n\n* Requires the `composer.json` and `composer.lock` files to be available and readable in the environment you plan to use this module. All information is based on these files.\n* The [queuedjobs module](https://github.com/symbiote/silverstripe-queuedjobs) updates metadata on your installed modules in the background. You need to [configure](https://github.com/symbiote/silverstripe-queuedjobs) it to run those jobs.\n* For the optional update checkers, the webserver environment needs to be able to contact external information sources through network requests\n* SilverStripe:\n  * Maintenance ^2.2: Silverstripe ^4.4\n  * Maintenance ~2.1.0: Silverstripe 4.0-4.3\n  * Maintenance: ^1.0: Silverstripe 3.x\n\n### Suggested Modules\n\nBy default, the module will read your installed modules,\nand present them as a report in the CMS under `admin/reports`.\n\nIn order to get information about potential updates to these modules,\nwe recommend the installation of the following additional module:\n\n- [bringyourownideas/silverstripe-composer-update-checker](https://github.com/bringyourownideas/silverstripe-composer-update-checker) checks for available updates of dependencies\n\nThe previously recommended silverstripe-composer-security-checker module [can't work anymore](https://github.com/bringyourownideas/silverstripe-composer-security-checker/issues/57) and isn't recommended to be used anymore.\n\n### Installation \n \nOption 1 (recommended): Install the maintenance package and suggested dependency\n\n```\ncomposer require bringyourownideas/silverstripe-maintenance bringyourownideas/silverstripe-composer-update-checker\n```\n\nOption 2 (minimal): Install only the maintenance package without any update checks\n\n```\ncomposer require bringyourownideas/silverstripe-maintenance\n```\n\nBuild schema and queue an initial job to populate the database:\n\n```\nsake dev/build\n```\n\nIf you haven't already, you need to [configure the job queue](https://github.com/symbiote/silverstripe-queuedjobs)\nto update module metadata in the background. By default, this happens every day,\nbut can be configured to run at different intervals through YAML config:\n\n```yaml\nBringYourOwnIdeas\\Maintenance\\Jobs\\CheckForUpdatesJob:\n  reschedule_delay: '+1 hour'\n```\n\n### Manually running tasks\n\nBy default, tasks are run through a job queue. You can also choose to manually refresh via the command line.\n\nRun the update task (includes the [update-checker](https://github.com/bringyourownideas/silverstripe-composer-update-checker))\n```\nsake dev/tasks/UpdatePackageInfoTask\n```\n\n## How your composer.json influences the report\n\nThe report available through the CMS shows \"Available\" and \"Latest\" versions (see [user guide](docs/en/userguide/index.md)).\nThe version recommendations in those columns depend on your\n`composer.json` configuration. When setting tight constraints (e.g. `silverstripe/framework:4.3.2@stable`),\nnewer releases don't show up as expected. We recommend to have looser constraints by default\n(e.g. `silverstripe/framework:^4.3`). When the \"Latest\" version shows `dev-master`,\nit likely means that you have `\"minimum-stability\": \"dev\"` in your `composer.json`.\n\n## Documentation\n\nPlease see the [user guide](docs/en/userguide/index.md) section.\n\n## Contributing\n\nContributions are welcome! Create an issue, explaining a bug or propose development ideas. Find more information on \n[contributing](https://docs.silverstripe.org/en/contributing/) in the Silverstripe developer documentation.\n\n## Reporting Issues\n\nPlease [create an issue](https://github.com/bringyourownideas/silverstripe-maintenance/issues) for any bugs you've found, or features you're missing.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbringyourownideas%2Fsilverstripe-maintenance","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbringyourownideas%2Fsilverstripe-maintenance","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbringyourownideas%2Fsilverstripe-maintenance/lists"}