diff --git a/dev/docs/development.md b/dev/docs/development.md new file mode 100644 index 000000000..6d11443b6 --- /dev/null +++ b/dev/docs/development.md @@ -0,0 +1,96 @@ +# Development & Testing + +All development on BookStack is currently done on the `development` branch. +When it's time for a release the `development` branch is merged into release with built & minified CSS & JS then tagged at its version. Here are the current development requirements: + +* [Node.js](https://nodejs.org/en/) v16.0+ + +This project uses SASS for CSS development and this is built, along with the JavaScript, using a range of npm scripts. The below npm commands can be used to install the dependencies & run the build tasks: + +``` bash +# Install NPM Dependencies +npm install + +# Build assets for development +npm run build + +# Build and minify assets for production +npm run production + +# Build for dev (With sourcemaps) and watch for changes +npm run dev +``` + +BookStack has many integration tests that use Laravel's built-in testing capabilities which makes use of PHPUnit. There is a `mysql_testing` database defined within the app config which is what is used by PHPUnit. This database is set with the database name, username and password all defined as `bookstack-test`. You will have to create that database and that set of credentials before testing. + +The testing database will also need migrating and seeding beforehand. This can be done by running `composer refresh-test-database`. + +Once done you can run `composer test` in the application root directory to run all tests. Tests can be ran in parallel by running them via `composer t`. This will use Laravel's built-in parallel testing functionality, and attempt to create and seed a database instance for each testing thread. If required these parallel testing instances can be reset, before testing again, by running `composer t-reset`. + +## Code Standards + +PHP code standards are managed by [using PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer). +Static analysis is in place using [PHPStan](https://phpstan.org/) & [Larastan](https://github.com/nunomaduro/larastan). +The below commands can be used to utilise these tools: + +```bash +# Run code linting using PHP_CodeSniffer +composer lint + +# As above, but show rule names in output +composer lint -- -s + +# Auto-fix formatting & lint issues via PHP_CodeSniffer phpcbf +composer format + +# Run static analysis via larastan/phpstan +composer check-static +``` + +If submitting a PR, formatting as per our project standards would help for clarity but don't worry too much about using/understanding these tools as we can always address issues at a later stage when they're picked up by our automated tools. + +## Development using Docker + +This repository ships with a Docker Compose configuration intended for development purposes. It'll build a PHP image with all needed extensions installed and start up a MySQL server and a Node image watching the UI assets. + +To get started, make sure you meet the following requirements: + +- Docker and Docker Compose are installed +- Your user is part of the `docker` group + +If all the conditions are met, you can proceed with the following steps: + +1. **Copy `.env.example` to `.env`**, change `APP_KEY` to a random 32 char string and set `APP_ENV` to `local`. +2. Make sure **port 8080 is unused** *or else* change `DEV_PORT` to a free port on your host. +3. **Run `chgrp -R docker storage`**. The development container will chown the `storage` directory to the `www-data` user inside the container so BookStack can write to it. You need to change the group to your host's `docker` group here to not lose access to the `storage` directory. +4. **Run `docker-compose up`** and wait until the image is built and all database migrations have been done. +5. You can now login with `admin@admin.com` and `password` as password on `localhost:8080` (or another port if specified). + +If needed, You'll be able to run any artisan commands via docker-compose like so: + +```bash +docker-compose run app php artisan list +``` + +The docker-compose setup runs an instance of [MailHog](https://github.com/mailhog/MailHog) and sets environment variables to redirect any BookStack-sent emails to MailHog. You can view this mail via the MailHog web interface on `localhost:8025`. You can change the port MailHog is accessible on by setting a `DEV_MAIL_PORT` environment variable. + +### Running tests + +After starting the general development Docker, migrate & seed the testing database: + + ```bash +# This only needs to be done once +docker-compose run app php artisan migrate --database=mysql_testing +docker-compose run app php artisan db:seed --class=DummyContentSeeder --database=mysql_testing +``` + +Once the database has been migrated & seeded, you can run the tests like so: + + ```bash +docker-compose run app php vendor/bin/phpunit +``` + +### Debugging + +The docker-compose setup ships with Xdebug, which you can listen to on port 9090. +NB : For some editors like Visual Studio Code, you might need to map your workspace folder to the /app folder within the docker container for this to work. diff --git a/dev/docs/release-process.md b/dev/docs/release-process.md new file mode 100644 index 000000000..758d6db4c --- /dev/null +++ b/dev/docs/release-process.md @@ -0,0 +1,24 @@ +# Release Versioning & Process + +### BookStack Version Number Scheme + +BookStack releases are each assigned a date-based version number in the format `v.[.]`. For example: + +- `v20.12` - New feature released launched during December 2020. +- `v21.06.2` - Second patch release upon the June 2021 feature release. + +Patch releases are generally fairly minor, primarily intended for fixes and therefore are fairly unlikely to cause breakages upon update. +Feature releases are generally larger, bringing new features in addition to fixes and enhancements. These releases have a greater chance of introducing breaking changes upon update, so it's worth checking for any notes in the [update guide](https://www.bookstackapp.com/docs/admin/updates/). + +### Release Planning Process + +Each BookStack release will have a [milestone](https://github.com/BookStackApp/BookStack/milestones) created with issues & pull requests assigned to it to define what will be in that release. Milestones are built up then worked through until complete at which point, after some testing and documentation updates, the release will be deployed. + +### Release Announcements + +Feature releases, and some patch releases, will be accompanied by a post on the [BookStack blog](https://www.bookstackapp.com/blog/) which will provide additional detail on features, changes & updates otherwise the [GitHub release page](https://github.com/BookStackApp/BookStack/releases) will show a list of changes. You can sign up to be alerted to new BookStack blog posts (once per week maximum) [at this link](https://updates.bookstackapp.com/signup/bookstack-news-and-updates). + +### Release Technical Process + +Deploying a release, at a high level, simply involves merging the development branch into the release branch before then building & committing any release-only assets. +A helper script [can be found in our](https://github.com/BookStackApp/devops/blob/main/meta-scripts/bookstack-release-steps) devops repo which provides the steps and commands for deploying a new release. \ No newline at end of file diff --git a/readme.md b/readme.md index 469ec88fd..b8bd17232 100644 --- a/readme.md +++ b/readme.md @@ -59,126 +59,20 @@ Note: Listed services are not tested, vetted nor supported by the official BookS ## 🛣️ Road Map -Below is a high-level road map view for BookStack to provide a sense of direction of where the project is going. This can change at any point and does not reflect many features and improvements that will also be included as part of the journey along this road map. For more granular detail of what will be included in upcoming releases you can review the project milestones as defined in the "Release Process" section below. +Below is a high-level road map view for BookStack to provide a sense of direction of where the project is going. This can change at any point and does not reflect many features and improvements that will also be included as part of the journey along this road map. For more granular detail of what will be included in upcoming releases you can review the project milestones as defined in our [Release Process](dev/docs/release-process.md) documentation. - **Platform REST API** - *(Most actions implemented, maturing)* - *A REST API covering, at minimum, control of core content models (Books, Chapters, Pages) for automation and platform extension.* -- **Editor Alignment & Review** - *(Done)* - - *Review the page editors with the goal of achieving increased interoperability & feature parity while also considering collaborative editing potential.* - **Permission System Review** - *(In Progress)* - *Improvement in how permissions are applied and a review of the efficiency of the permission & roles system.* -- **Installation & Deployment Process Revamp** - - *Creation of a streamlined & secure process for users to deploy & update BookStack with reduced development requirements (No git or composer requirement).* - -## 🚀 Release Versioning & Process - -BookStack releases are each assigned a date-based version number in the format `v.[.]`. For example: - -- `v20.12` - New feature released launched during December 2020. -- `v21.06.2` - Second patch release upon the June 2021 feature release. - -Patch releases are generally fairly minor, primarily intended for fixes and therefore are fairly unlikely to cause breakages upon update. -Feature releases are generally larger, bringing new features in addition to fixes and enhancements. These releases have a greater chance of introducing breaking changes upon update, so it's worth checking for any notes in the [update guide](https://www.bookstackapp.com/docs/admin/updates/). - -Each BookStack release will have a [milestone](https://github.com/BookStackApp/BookStack/milestones) created with issues & pull requests assigned to it to define what will be in that release. Milestones are built up then worked through until complete at which point, after some testing and documentation updates, the release will be deployed. - -Feature releases, and some patch releases, will be accompanied by a post on the [BookStack blog](https://www.bookstackapp.com/blog/) which will provide additional detail on features, changes & updates otherwise the [GitHub release page](https://github.com/BookStackApp/BookStack/releases) will show a list of changes. You can sign up to be alerted to new BookStack blog posts (once per week maximum) [at this link](https://updates.bookstackapp.com/signup/bookstack-news-and-updates). ## 🛠️ Development & Testing -All development on BookStack is currently done on the `development` branch. When it's time for a release the `development` branch is merged into release with built & minified CSS & JS then tagged at its version. Here are the current development requirements: +Please see our [development docs](dev/docs/development.md) for full details regarding work on the BookStack source code. -* [Node.js](https://nodejs.org/en/) v14.0+ +If you're just looking to customize or extend your own BookStack instance, take a look at our [Hacking BookStack documentation page](https://www.bookstackapp.com/docs/admin/hacking-bookstack/) for details on various options to achieve this without altering the BookStack source code. -This project uses SASS for CSS development and this is built, along with the JavaScript, using a range of npm scripts. The below npm commands can be used to install the dependencies & run the build tasks: - -``` bash -# Install NPM Dependencies -npm install - -# Build assets for development -npm run build - -# Build and minify assets for production -npm run production - -# Build for dev (With sourcemaps) and watch for changes -npm run dev -``` - -BookStack has many integration tests that use Laravel's built-in testing capabilities which makes use of PHPUnit. There is a `mysql_testing` database defined within the app config which is what is used by PHPUnit. This database is set with the database name, user name and password all defined as `bookstack-test`. You will have to create that database and that set of credentials before testing. - -The testing database will also need migrating and seeding beforehand. This can be done by running `composer refresh-test-database`. - -Once done you can run `composer test` in the application root directory to run all tests. Tests can be ran in parallel by running them via `composer t`. This will use Laravel's built-in parallel testing functionality, and attempt to create and seed a database instance for each testing thread. If required these parallel testing instances can be reset, before testing again, by running `composer t-reset`. - -### 📜 Code Standards - -PHP code standards are managed by [using PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer). -Static analysis is in place using [PHPStan](https://phpstan.org/) & [Larastan](https://github.com/nunomaduro/larastan). -The below commands can be used to utilise these tools: - -```bash -# Run code linting using PHP_CodeSniffer -composer lint - -# As above, but show rule names in output -composer lint -- -s - -# Auto-fix formatting & lint issues via PHP_CodeSniffer phpcbf -composer format - -# Run static analysis via larastan/phpstan -composer check-static -``` - -If submitting a PR, formatting as per our project standards would help for clarity but don't worry too much about using/understanding these tools as we can always address issues at a later stage when they're picked up by our automated tools. - -### 🐋 Development using Docker - -This repository ships with a Docker Compose configuration intended for development purposes. It'll build a PHP image with all needed extensions installed and start up a MySQL server and a Node image watching the UI assets. - -To get started, make sure you meet the following requirements: - -- Docker and Docker Compose are installed -- Your user is part of the `docker` group - -If all the conditions are met, you can proceed with the following steps: - -1. **Copy `.env.example` to `.env`**, change `APP_KEY` to a random 32 char string and set `APP_ENV` to `local`. -2. Make sure **port 8080 is unused** *or else* change `DEV_PORT` to a free port on your host. -3. **Run `chgrp -R docker storage`**. The development container will chown the `storage` directory to the `www-data` user inside the container so BookStack can write to it. You need to change the group to your host's `docker` group here to not lose access to the `storage` directory. -4. **Run `docker-compose up`** and wait until the image is built and all database migrations have been done. -5. You can now login with `admin@admin.com` and `password` as password on `localhost:8080` (or another port if specified). - -If needed, You'll be able to run any artisan commands via docker-compose like so: - -```bash -docker-compose run app php artisan list -``` - -The docker-compose setup runs an instance of [MailHog](https://github.com/mailhog/MailHog) and sets environment variables to redirect any BookStack-sent emails to MailHog. You can view this mail via the MailHog web interface on `localhost:8025`. You can change the port MailHog is accessible on by setting a `DEV_MAIL_PORT` environment variable. - -#### Running tests - -After starting the general development Docker, migrate & seed the testing database: - - ```bash -# This only needs to be done once -docker-compose run app php artisan migrate --database=mysql_testing -docker-compose run app php artisan db:seed --class=DummyContentSeeder --database=mysql_testing -``` - -Once the database has been migrated & seeded, you can run the tests like so: - - ```bash -docker-compose run app php vendor/bin/phpunit -``` - -#### Debugging - -The docker-compose setup ships with Xdebug, which you can listen to on port 9090. -NB : For some editors like Visual Studio Code, you might need to map your workspace folder to the /app folder within the docker container for this to work. +Details about BookStack's versioning scheme and the general release process [can be found here](dev/docs/release-process.md). ## 🌎 Translations @@ -212,7 +106,7 @@ We want BookStack to remain accessible to as many people as possible. We aim for ## 🖥️ Website, Docs & Blog -The website which contains the project docs & Blog can be found in the [BookStackApp/website](https://github.com/BookStackApp/website) repo. +The website which contains the project docs & blog can be found in the [BookStackApp/website](https://github.com/BookStackApp/website) repo. ## ⚖️ License