Skip to content

Commit

Permalink
Merge pull request #561 from hydephp/develop
Browse files Browse the repository at this point in the history
HydePHP v1.0.0 - Release Candidate One
  • Loading branch information
caendesilva authored Mar 7, 2023
2 parents c5004d9 + 1132155 commit 9bea97a
Show file tree
Hide file tree
Showing 495 changed files with 25,607 additions and 11,280 deletions.
2 changes: 1 addition & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
* text=auto
* text eol=lf

*.blade.php diff=html
*.css diff=css
Expand Down
35 changes: 24 additions & 11 deletions .github/workflows/run-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,33 +12,51 @@ jobs:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
php: [8.1]
php: [8.1, 8.2]
runs-on: ${{ matrix.os }}

steps:
- uses: actions/checkout@v2
- uses: shivammathur/setup-php@16011a795d747d5f45038f96371c3b98aec5669d
with:
php-version: ${{ matrix.php }}
extensions: fileinfo
coverage: xdebug
- name: Install Hyde
extensions: fileinfo, zip

- name: Echo GitHub ref
run: echo ${{ github.ref }}

- name: Install Hyde (master)
if: "github.ref == 'refs/heads/master'"
run: git clone -b master https://github.com/hydephp/hyde.git

- name: Install Hyde (develop)
if: "github.ref != 'refs/heads/master'"
run: git clone -b develop https://github.com/hydephp/hyde.git

- name: Require latest master version
if: "github.ref == 'refs/heads/master'"
run: cd hyde && composer require hyde/framework:dev-master --no-install

- name: Require latest development version
if: "github.ref != 'refs/heads/master'"
run: cd hyde && composer require hyde/framework:dev-develop --no-install

- name: Install Dependencies
run: |
cd hyde
composer require hyde/framework:dev-master --no-install
composer require hyde/testing:dev-master --dev --no-install
composer install
- name: Copy over test files
run: cp -r ./tests/. ./hyde/tests

- name: Download test runner configuration
run: cd hyde && curl https://raw.githubusercontent.com/hydephp/develop/master/packages/hyde/phpunit.xml.dist -o phpunit.xml.dist

- name: Set environment to testing
run: cd hyde && echo "ENV=testing" > .env
- name: Execute tests (Unit and Feature tests) via PHPUnit/Pest
run: cd hyde && vendor/bin/pest --coverage --coverage-text=report.txt --colors=always --coverage-clover build/coverage/clover.xml --coverage-cobertura build/coverage/cobertura.xml --coverage-crap4j build/coverage/crap4j.xml --coverage-xml build/coverage/coverage-xml --log-junit build/junit.xml --testdox-text testdox.txt
run: cd hyde && vendor/bin/pest
env:
ENV: testing

Expand All @@ -47,8 +65,3 @@ jobs:
cd hyde
curl https://gist.githubusercontent.com/caendesilva/d76fc6d73cb488863a8f6fda18a7c8c4/raw/1d22747e5064b40e4da05e7666d1ab1d2766de7a/ping-openanalytics-testrunner.php -o ping.php
php ping.php "Framework CI Matrix" ${{ secrets.OPENANALYTICS_TOKEN }}
- name: "Publish coverage report to Codecov"
uses: codecov/codecov-action@v3
with:
functionalities: network
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

![framework](https://user-images.githubusercontent.com/95144705/172196099-b5604f9b-90aa-4fac-bd17-b5a150ebf8f5.png)

[![Latest Version on Packagist](https://img.shields.io/packagist/v/hyde/framework?include_prereleases)](https://packagist.org/packages/hyde/framework)
[![Total Downloads on Packagist](https://img.shields.io/packagist/dt/hyde/framework)](https://packagist.org/packages/hyde/framework)
[![Latest Version on Packagist](https://img.shields.io/packagist/v/hyde/framework?include_prereleases)](https://packagist.org/packages/hyde/framework)
[![Total Downloads on Packagist](https://img.shields.io/packagist/dt/hyde/framework)](https://packagist.org/packages/hyde/framework)
[![License MIT](https://img.shields.io/github/license/hydephp/hyde) ](https://github.com/hydephp/hyde/blob/master/LICENSE.md)
[![Test Coverage](https://codecov.io/gh/hydephp/develop/branch/master/graph/badge.svg?token=G6N2161TOT)](https://codecov.io/gh/hydephp/develop)
[![Test Suite](https://github.com/hydephp/develop/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/hydephp/develop/actions/workflows/continuous-integration.yml)
Expand All @@ -29,7 +29,7 @@ Hyde has already been featured in the [Laravel News Podcast](https://laravel-new
- [HydePHP/Hydefront](https://github.com/hydephp/hydefront) - The Hyde frontend assets. Extracted from the HydePHP/Framework repo to improve testing and allow for easier deployment using a CDN.


## ⚠ Beta Software Warning
## ⚠ Beta Software Warning
Heads up! HydePHP is very new and currently in beta. Please report any bugs and issues in the appropriate issue tracker. Versions in the 0.x series are not stable and may change at any time. No backwards compatibility guarantees are made and there will be breaking changes without notice.

Please wait until v1.0 for production use and remember to back up your source files before updating (use Git!).
Expand Down
8 changes: 4 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"license": "MIT",
"autoload": {
"psr-4": {
"Hyde\\Framework\\": "src/"
"Hyde\\": "src/"
},
"files": [
"src/helpers.php"
Expand All @@ -23,8 +23,8 @@
],
"require": {
"php": "^8.1",
"illuminate/support": "^9.5",
"illuminate/view": "^9.0",
"illuminate/support": "^10.0",
"illuminate/view": "^10.0",
"symfony/yaml": "^6.0",
"league/commonmark": "^2.2",
"spatie/yaml-front-matter": "^2.0.7",
Expand All @@ -33,6 +33,6 @@
"suggest": {
"hyde/hyde" : "The Framework package contains the Hyde Core. To create your site you should use the Hyde/Hyde project.",
"ext-simplexml": "Required to generate sitemaps and RSS feeds.",
"laravel-zero/framework": "^9.1"
"laravel-zero/framework": "^10.0"
}
}
12 changes: 12 additions & 0 deletions config/cache.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?php

return [
'default' => 'file',

'stores' => [
'file' => [
'driver' => 'file',
'path' => storage_path('framework/cache/data'),
],
],
];
83 changes: 83 additions & 0 deletions config/commands.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
<?php

return [

/*
|--------------------------------------------------------------------------
| Default Command
|--------------------------------------------------------------------------
|
| Laravel Zero will always run the command specified below when no command name is
| provided. Consider update the default command for single command applications.
| You cannot pass arguments to the default command because they are ignored.
|
*/

'default' => NunoMaduro\LaravelConsoleSummary\SummaryCommand::class,

/*
|--------------------------------------------------------------------------
| Commands Paths
|--------------------------------------------------------------------------
|
| This value determines the "paths" that should be loaded by the console's
| kernel. Foreach "path" present on the array provided below the kernel
| will extract all "Illuminate\Console\Command" based class commands.
|
*/

'paths' => [app_path('Commands')],

/*
|--------------------------------------------------------------------------
| Added Commands
|--------------------------------------------------------------------------
|
| You may want to include a single command class without having to load an
| entire folder. Here you can specify which commands should be added to
| your list of commands. The console's kernel will try to load them.
|
*/

'add' => [
//
],

/*
|--------------------------------------------------------------------------
| Hidden Commands
|--------------------------------------------------------------------------
|
| Your application commands will always be visible on the application list
| of commands. But you can still make them "hidden" specifying an array
| of commands below. All "hidden" commands can still be run/executed.
|
*/

'hidden' => [
NunoMaduro\LaravelConsoleSummary\SummaryCommand::class,
Symfony\Component\Console\Command\DumpCompletionCommand::class,
Symfony\Component\Console\Command\HelpCommand::class,
\Hyde\Console\Commands\DebugCommand::class,
],

/*
|--------------------------------------------------------------------------
| Removed Commands
|--------------------------------------------------------------------------
|
| Do you have a service provider that loads a list of commands that
| you don't need? No problem. Laravel Zero allows you to specify
| below a list of commands that you don't to see in your app.
|
*/

'remove' => [
Illuminate\Console\Scheduling\ScheduleRunCommand::class,
Illuminate\Console\Scheduling\ScheduleListCommand::class,
Illuminate\Console\Scheduling\ScheduleFinishCommand::class,
Illuminate\Console\Scheduling\ScheduleRunCommand::class,
LaravelZero\Framework\Commands\StubPublishCommand::class,
],

];
98 changes: 54 additions & 44 deletions config/docs.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,59 +11,28 @@
*/

return [
/*
|--------------------------------------------------------------------------
| Sidebar Header Name
|--------------------------------------------------------------------------
|
| By default, the sidebar title shown in the documentation page layouts uses
| the app name suffixed with "docs". You can change it with this setting.
|
*/

'header_title' => config('site.name', 'HydePHP').' Docs',

/*
|--------------------------------------------------------------------------
| Documentation Site Output Directory
| Sidebar Settings
|--------------------------------------------------------------------------
|
| If you want to store the compiled documentation pages in a different
| directory than the default 'docs' directory, for example to set the
| specified version, you can specify the directory here.
|
| Note that you need to take care as to not set it to something that
| may conflict with other parts, such as media or posts directories.
|
| The default value is 'docs'. For easy versioning you can do what
| HydePHP.com does, setting it to 'docs/master'.
| The Hyde Documentation Module comes with a fancy Sidebar that is
| automatically populated with links to your documentation pages.
| Here, you can configure its behavior, content, look and feel.
|
*/

'output_directory' => 'docs',
'sidebar' => [
// The title in the sidebar header
'header' => env('SITE_NAME', 'HydePHP').' Docs',

/*
|--------------------------------------------------------------------------
| Collaborative Source Editing Location
|--------------------------------------------------------------------------
|
| @see https://hydephp.com/docs/master/documentation-pages#automatic-edit-page-button
|
| By adding a base URL here, Hyde will use it to create "edit source" links
| to your documentation pages. Hyde expects this to be a GitHub path, but
| it will probably work with other methods as well, if not, send a PR!
|
| You can also change the link text with the `edit_source_link_text` setting.
|
| Example: https://github.com/hydephp/docs/blob/master
| Do not specify the filename or extension, Hyde will do that for you.
| Setting the setting to null will disable the feature.
|
*/
// When using a grouped sidebar, should the groups be collapsible?
'collapsible' => true,

// 'source_file_location_base' => 'https://github.com/<user>/<repo>/<[blob/edit]>/<branch>',
'edit_source_link_text' => 'Edit Source',
'edit_source_link_position' => 'footer', // 'header', 'footer', or 'both'
// Should the sidebar footer be shown?
'footer' => true,
],

/*
|--------------------------------------------------------------------------
Expand All @@ -74,7 +43,7 @@
| default to sort alphabetically. You can reorder the page identifiers
| in the list below, and the links will get sorted in that order.
|
| Internally, the items listed will get a position priority of 250 + the order its found in the list.
| Internally, the items listed will get a position priority of 500 + the order its found in the list.
| Link items without an entry here will have fall back to the default priority of 999, putting them last.
|
| You can also set explicit priorities in front matter.
Expand Down Expand Up @@ -104,6 +73,29 @@
'max_heading_level' => 4,
],

/*
|--------------------------------------------------------------------------
| Collaborative Source Editing Location
|--------------------------------------------------------------------------
|
| @see https://hydephp.com/docs/master/documentation-pages#automatic-edit-page-button
|
| By adding a base URL here, Hyde will use it to create "edit source" links
| to your documentation pages. Hyde expects this to be a GitHub path, but
| it will probably work with other methods as well, if not, send a PR!
|
| You can also change the link text with the `edit_source_link_text` setting.
|
| Example: https://github.com/hydephp/docs/blob/master
| Do not specify the filename or extension, Hyde will do that for you.
| Setting the setting to null will disable the feature.
|
*/

// 'source_file_location_base' => 'https://github.com/<user>/<repo>/<[blob/edit]>/<branch>',
'edit_source_link_text' => 'Edit Source',
'edit_source_link_position' => 'footer', // 'header', 'footer', or 'both'

/*
|--------------------------------------------------------------------------
| Search Customization
Expand All @@ -122,4 +114,22 @@
'changelog',
],

/*
|--------------------------------------------------------------------------
| Flattened Output Paths
|--------------------------------------------------------------------------
|
| If this setting is set to true, Hyde will output all documentation pages
| into the same configured documentation output directory. This means
| that you can use the automatic directory based grouping feature,
| but still have a "flat" output structure. Note that this means
| that you can't have two documentation pages with the same
| filename or navigation menu label as they will overwrite each other.
|
| If you set this to false, Hyde will match the directory structure
| of the source files (just like all other pages).
|
*/

'flattened_output_paths' => true,
];
Loading

0 comments on commit 9bea97a

Please sign in to comment.