You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Julius Härtl dc21c8ad4b
Bump webpack-dev-server from 3.7.0 to 3.7.1 (#105)
5 days ago
appinfo Make issuetemplate 15 compatible 5 months ago
css Fix rendering on Nextcloud 14 10 months ago
img Add icon for settings section in NC12 2 years ago
js Move to webpack 4 2 months ago
lib Rename browser log to web server error log 3 months ago
templates Make issuetemplate 15 compatible 5 months ago
tests Fix autoloading for tests 10 months ago
.drone.yml Diable checker for now 2 months ago
.gitignore Add gitignore 10 months ago
AUTHORS.md Initial commit for issue template app 2 years ago
CHANGELOG.md Update CHANGELOG 10 months ago
COPYING Initial commit for issue template app 2 years ago
Makefile Run composer before tests 10 months ago
README.md Allow apps to define custom bug report details 1 year ago
composer.json Add rendered markdown preview 10 months ago
composer.lock Bump erusev/parsedown from 1.7.1 to 1.7.3 2 months ago
krankerl.toml Add krankerl config 10 months ago
package-lock.json Bump webpack-dev-server from 3.7.0 to 3.7.1 1 week ago
package.json Bump webpack-dev-server from 3.7.0 to 3.7.1 1 week ago
screenshot.png Update screenshot 10 months ago

README.md

Issue Template

Nextcloud app to prefill github issue with current server information.

Screenshot

Place this app in nextcloud/apps/

Building the app

The app can be built by using the provided Makefile by running:

make

This requires the following things to be present:

  • make
  • which
  • tar: for building the archive
  • curl: used if phpunit and composer are not installed to fetch them from the web
  • npm: for building and testing everything JS, only required if a package.json is placed inside the js/ folder

The make command will install or update Composer dependencies if a composer.json is present and also npm run build if a package.json is present in the js/ folder. The npm build script should use local paths for build systems and package managers, so people that simply want to build the app won’t need to install npm libraries globally, e.g.:

package.json:

"scripts": {
    "test": "node node_modules/gulp-cli/bin/gulp.js karma",
    "prebuild": "npm install && node_modules/bower/bin/bower install && node_modules/bower/bin/bower update",
    "build": "node node_modules/gulp-cli/bin/gulp.js"
}

Publish to App Store

First get an account for the App Store then run:

make && make appstore

The archive is located in build/artifacts/appstore and can then be uploaded to the App Store.

Running tests

You can use the provided Makefile to run all tests by using:

make test

This will run the PHP unit and integration tests and if a package.json is present in the js/ folder will execute npm run test

Of course you can also install PHPUnit and use the configurations directly:

phpunit -c phpunit.xml

or:

phpunit -c phpunit.integration.xml

for integration tests

Integration for app developers

Apps will appear automatically in the issue template app once their appinfo.xml contains a <bugs> tag with an URL to the GitHub issue tracker.

Adding custom details to your issue report:

$dispatcher = \OC::$server->getEventDispatcher();
$dispatcher->addListener('\OCA\IssueTemplate::queryAppDetails', function(GenericEvent $event) {
    if($event->getArgument('app') === 'deck') {
        $manager = \OC::$server->query(\OCA\IssueTemplate\DetailManager::class);
        $section = new \OCA\IssueTemplate\Section('server-config', 'Server configuration');
        $section->createDetail('Operating system', php_uname());
        $section->createDetail('PHP version', PHP_VERSION);
        $manager->addSection($section);
    }
});

Sections provided by default can be disabled using \OCA\IssueTemplate\DetailManager::removeSection($sectionName) method. Currently the following 3 section names are provided by default:

  • server-detail
  • log-detail
  • client-detail