diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ff48700e85..ad1095c3be 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,7 @@ @@ -14,4 +14,3 @@ ATTENTION: ALL NEW PRs SHOULD TARGET 3.x BRANCH (unless they are not compatible - diff --git a/Build/Jenkins/update-neos-ui-compiled.sh b/Build/Jenkins/update-neos-ui-compiled.sh index 3912ef850a..3ceab61e87 100755 --- a/Build/Jenkins/update-neos-ui-compiled.sh +++ b/Build/Jenkins/update-neos-ui-compiled.sh @@ -37,7 +37,7 @@ cd tmp_compiled_pkg git add Resources/Public/ git commit -m "Compile Neos UI - $GIT_SHA1" || true -if [[ "$GIT_BRANCH" == "origin/master" || "$GIT_BRANCH" == "origin/3.x" ]]; then +if [[ "$GIT_BRANCH" == "origin/master" || "$GIT_BRANCH" == "origin/4.0" || "$GIT_BRANCH" == "origin/5.0" ]]; then echo "Git branch $GIT_BRANCH found, pushing to this branch." git push origin HEAD:${GIT_BRANCH#*/} fi diff --git a/README.md b/README.md index 9ab3f096b1..661454864b 100644 --- a/README.md +++ b/README.md @@ -6,21 +6,13 @@ ## Versioning -Since Neos 5.0 (scheduled August 2019) this repository will become obsolete and `neos-ui` will be versioned and releases together with with the rest of Neos core packages. +This repository follows the same versioning scheme as Neos itself, with the only exception that the 4.0 branch works with all Neos 4.x releases. +Release roadmap is [available here](https://www.neos.io/features/release-process.html) -Until then, the following version conventions are in place: -- 2.x versions are Neos 3.3 compatible (released from the `2.x` branch) -- 3.x versions are Neos 4.x compatible (released from `3.x` branch) -- 5.x versions are Neos 5.x compatible (released from `master`) -- We follow semver, but do not make bugfix releases for previous minor branches - -For users this means: **You will not get bugfixes for previous minor releases, so use a more relaxed version constraint like these:** - -``` -"neos/neos-ui": "^3", -``` - -For developers this means: **All development happens in `3.x` branch and then getting upmered to `master`** +That means: +* All bugfixes go to the least maintained branch +* All new features go only to master +* New minor and major releases are made in sync with Neos/Flow. Bugfix releases may be available independantly ## Browser support @@ -73,7 +65,7 @@ Please follow the respective guides for contributing on OSX and on Linux. ### on Windows -1) Ensure you have the `3.x` or `dev-master` version installed (see above). +1) Ensure you have the relevant version installed (see above). 2) Please install Docker for Windows. @@ -94,7 +86,7 @@ Neos: In order to start contributing on OSX / Linux, follow the following steps: -1) Ensure you have the `3.x` or `dev-master` version installed (see above). +1) Ensure you have the relevant version installed (see above). 2) We require [Chrome](https://www.google.com/chrome/browser/desktop/index.html) as well as the `yarn`(https://yarnpkg.com/en/) command and GNU Make(https://www.gnu.org/software/make/) to be installed on your system. @@ -124,16 +116,14 @@ on how to write meaningful descriptions for your contributions. #### Doing upmerges -1) Develop only in the `3.x` branch, unless this feature is only compatible with Neos 5.x, then in `master` - -2) To do the upmerge do the following commands +To do the upmerge run the following commands ``` -git checkout master && git fetch && git reset --hard origin/master && git merge --no-ff --no-commit origin/3.x --strategy-option=ours +git checkout 5.0 && git fetch && git reset --hard origin/5.0 && git merge --no-ff --no-commit origin/4.0 --strategy-option=ours +# review and `git commit` +git checkout master && git fetch && git reset --hard origin/master && git merge --no-ff --no-commit origin/5.0 --strategy-option=ours +# review and `git commit` ``` -Review the changes and commit the changes with the following commit message: - -`MERGE: Merge branch '3.x' into master` #### Development commands | Command | Description | @@ -168,9 +158,6 @@ module.exports = { }; ``` -#### Code style -Our code style is based upon `xo`, with one big difference - We use 4 spaces instead of tabs, to align our code style a bit with the PSR-2 standard for our PHP codebase. To lint the code, execute `make lint` in your shell. - #### Writing unit tests The unit tests are executed with [jest](https://facebook.github.io/jest/). To run the unit tests, execute `make test` in your shell. @@ -181,7 +168,7 @@ Use `it.only(() => {})` and `describe.only(() => {})` if you want to run a speci #### Integration tests -To setup end-to-end tests locally you have got to do the same things described in [CircleCI workflow](https://github.com/neos/neos-ui/blob/3.x/.circleci/config.yml), namely take the [test disribution](https://github.com/neos/neos-ui/blob/3.x/Tests/IntegrationTests/TestDistribution/composer.json) and `composer install` in it, put the right branch into Neos.Neos.Ui folder and run webserver and mysql server with the same config as described in the test distribution's [Settings.yaml](https://github.com/neos/neos-ui/blob/3.x/Tests/IntegrationTests/TestDistribution/Configuration/Settings.yaml) (or adjust it). +To setup end-to-end tests locally you have got to do the same things described in [CircleCI workflow](https://github.com/neos/neos-ui/blob/master/.circleci/config.yml), namely take the [test disribution](https://github.com/neos/neos-ui/blob/master/Tests/IntegrationTests/TestDistribution/composer.json) and `composer install` in it, put the right branch into Neos.Neos.Ui folder and run webserver and mysql server with the same config as described in the test distribution's [Settings.yaml](https://github.com/neos/neos-ui/blob/master/Tests/IntegrationTests/TestDistribution/Configuration/Settings.yaml) (or adjust it). #### Releasing