XP Framework repository reorganization

[thekid]

Scope of Change

The top-level directory core will be collapsed into .

Rationale

The layout is inconsisent with other repositories and causes problems with Maven builds.

Functionality

The repository https://github.com/xp-framework/xp-framework will be reorganized into a new repository https://github.com/xp-framework/core. The

https://github.com/xp-framework/core
|- src 
|  |- main/php
|  `- test/php
|- tools
|  |- lang.base.php
|  |- class.php
|  `- web.php
|- boot.pth
|- ChangeLog.md
|- pom.xml
|- xpbuild.json
|- .travis.yml
`- README.md

Steps

First, the new repository will be created empty via GitHub. Second, the

$ git clone git@github.com:xp-framework/xp-framework.git xpfw-transition-to-6
Cloning into 'xpfw-transition-to-6'...
# ...
$ cd xpfw-transition-to-6
$ git mv core/boot.pth .
$ git mv core/ChangeLog.md .
$ git mv core/src/ .
$ git mv core/tools/ .
$ git rm -r core/
$ git ci -m 'Remove "core" directory
> Implements phase 2 of the migration plan in xp-framework/rfc#278' .
# ...

Third, the results will be pushed to the newly created repository:

$ git remote rm origin
$ git remote add origin git@github.com:xp-framework/core.git
$ git push origin master

Finally, the build system will be adapted by fixing up xpbuild.json, .gitignore and the documentation.

Commit messages

The commit messages will be changed to now longer use the PHP group's style; and instead use the style described here:

Capitalized, short (50 chars or less) summary

More detailed explanatory text, if necessary.  Wrap it to about 72
characters or so.  In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body.  The blank
line separating the summary from the body is critical (unless you omit
the body entirely); tools like rebase can get confused if you run the
two together.

Write your commit message in the imperative: "Fix bug" and not "Fixed bug"
or "Fixes bug."  This convention matches up with commit messages generated
by commands like git merge and git revert.

Further paragraphs come after blank lines.

- Bullet points are okay, too

- Typically a hyphen or asterisk is used for the bullet, followed by a
  single space, with blank lines in between, but conventions vary here

- Use a hanging indent

Security considerations

Speed impact

Dependencies

A framework developer or one using a development checkout must edit their USE_XP variable. This will break if they use XP 5.9 and XP 6.0 in parallel; but people may choose to follow the filesystem layout recommended here

Related documents

• RFC XP Language Repository reorganization #274 - XP Language Repository reorganization
• RFC Split up framework into minimal pieces #262 - Split up framework into minimal pieces
• RFC XP 6 #172 - XP 6

[thekid]

GitHub and Travis settings

• Webhook for releases enabled
• Travis-CI enabled, https://travis-ci.org/xp-framework/core/builds/13740431

[thekid]

To retain the directory structure you had before (/path/to/xp-framework + core inside), create a xp-framework directory and clone the "core" repository inside as follows:

# Move away the old one
$ mv xp-framework xp-59

# Checkout the new "core" repo
$ mkdir xp-framework
$ cd xp-framework
$ git clone git@github.com:xp-framework/core.git