Download the PHP package code711/siteconfiggitsync without Composer

TYPO3 Site config - git synchronisation

Sometimes it is necessary for a TYPO3 project that the site-config yaml files are managed in git alongside the site-package. Those projects have the problem that site-admins can then not change settings in the site config without manually carrying those changes back over to the git repository in order for them not to be overriden with the next CI/CD run or publish.

This extension aims to alleviate this problem by pushing those changes back to your GitLab instance automatically. In doing so the extension will create a branch, check in the changes that have been made and create a merge-request which you then can manage in GitLab without manually merging the yaml files. And you will be notified about the changes because of the merge-request.

There is no git binary on the server needed, everything is done through the GitLab API. GitHub and GitLab (selfhosted or GitLab.com) are supported.

Changelog

3.0.1

• relaxed dependency on m4tthumphrey/php-gitlab-api to allow for 11.x and 12.x versions

3.0.0

• added TYPO3 14 support (TYPO3 13.4 is still supported)
• requires EXT:siteconfigurationevents 2.x or 3.x, use 3.x on TYPO3 14
• updated to m4tthumphrey/php-gitlab-api 12.x
• renaming/moving a site config is now done with a single git move commit instead of committing a new file and deleting the old one (GitLab only, see notes and limitations)
• improved automatic merge:
  • if the merge-request already exists, the open merge-request for that branch is picked up instead of being skipped
  • merge readiness is now determined by GitLabs detailed_merge_status and by whether the token user is actually allowed to merge
• added config option 'Remove Source Branch' to set the remove_source_branch flag on the merge request (GitLab)
• added config option 'Squash' to set the squash flag on the merge request (GitLab)

2.1.3

Bugfix in extension configurator:

• branch was not selected in dropdown

2.1.2 & 1.2.2

Changed logic when the Eventhandlers actually act:

• if TYPO3 is in Production-mode
• if the Environment Variable SITECONFIGGITSYNC_ENABLE is set to 1

2.1.0

• added new feature for automatic merge if possible
• added config option in extension configuration to enable automatic merge

2.0.0

• deprecated TYPO3 11 support
• deprecated TYPO3 12 Support
• added Eventlistener for writing settings.yaml
• added support for moving settings.yaml
• added support for deleting settings.yaml

1.1.0

• added GitHub support

1.0.3

• fixed issue #1
• fixed issue reading the user-list in the extension configuration interface when a project is not part of a group
• added LoggerAwareInterface to AfterConfigurationWriteListener

1.0.1

Fix README.md

1.0.0

Support TYPO3 12

0.10.0

Externalised the XCLASS of the SiteConfiguration Class to EXT:siteconfigurationevents. Composer installations should pull this extension automatically as a dependency. Refactored the git related actions into event listeners.

0.9.x Initial release

Setup / Installation

GitLab token

after installing this extension with

composer req code711/siteconfiggitsync

This is done in your GitLab in your Project under 'Settings->Access Token'. Developer Permissions are needed because only from this level on Branches can be created and Merge-requests can be issued.

In the field 'Token name' enter something meaningfull for this task, as it will be written next to commits or merge-requests. For example 'External Site change from TYPO3'.

Set the 'Expiration Date' to your liking.

In 'Select a role' choose 'Developer'

And for the scope select 'api'. The other scopes are not enough for the tasks we want to do.

after pressing the 'Create project access token' button you will be given a series of alphanumeric character. Copy this string of character. This is your token.

GitHub token

after installing this extension with

composer req code711/siteconfiggitsync

The setup for GitHub is from TYPO3 Point of view the same as in the above GitLab setup.

The main difference is how to access your ACCESS_TOKEN.

In GitHub access tokens are always personal tied to a user. The token can be created inside an organisation or team, but it has to be created as a personal token by one of its members.

To do that access your GitHub dashboard, and click on your profile Icon. Choose the entry "Settings". In the following page choose 'Developer Settings' on the left hand side of the screen. Finally open up the Option "Personal access tokens" and choose the option "Fine-grained tokens"

You should be here then Fine-grained personal access token

If you don't see the organisation or team where your project is located you have to enrol the organisation or team once. This is done from the Organisation Overview screen by choosing "Settings" in to top menu and then "Personal access tokens" - here you will then be able to enrol your organisation. Once you've done that, return to the "Developer Settings" screen, your organisation will then be listed there.

Create a personal access token of the type "Fine-grained token" and restrict it to the repository you want to push your changes to. The following permissions are needed:

• "Contents" - read & write
• "Pull requests" - read & write
• "Metadata" - readonly

save and store the token

TYPO3 Backend config

In your TYPO3 backend navigate to Settings->Extension Configuration and open the accordion for the siteconfiggitsync extension:

Choose 'GitLab' or 'GitHub' in the service dropdown (v1.1)

In the field project url add the complete URL to your projects repository, without any .git. Just as it is in your browser. for example

https://GitLab.com/mycompany/customerproject 

In the field API Auth Token enter the token you just generated.

Now press the "Save 'siteconfiggitsync' Configuration" button, and close the window. Re-open the window and navigate again to the siteconfiggitsync accordion and open it. The fields 'main_branch' and 'Who to assign a merge request' should be filled with respectively the available branches in that project and members who are allowed to merge merge-requests.

Choose the branch which represents the production branch, i.e. from which the branch to commit the changes should be taken.

Optionaly choose a member who gets the merge-requests assigend to. If no member is chosen the merge-requests will not be assigend to anybody, and it depends on your setup if you are notified when one is created.

Now press the "Save 'siteconfiggitsync' Configuration" button again, and you should be ready to accept merge-requests when the site-config is changed through the backend interface.

Merge request options

• Automatically merge (mergerequest_automerge, default off): the created branch will try to merge itself with squash and then delete the branch again, which retains the history. If no automatic merge can be done the user will be notified about the merge request instead. This feature has a few dependencies in setup and permissions, and is not guaranteed to succeed - the token user needs permission to merge into the production branch, and the merge-request has to be mergeable (no conflicts, no unmet approval rules or pending pipelines).
• (Gitlab) Remove Source Branch (mergerequest_remove_source_branch, default on): sets the remove_source_branch flag on the merge request, so the automated branch is deleted when the merge-request is merged - also when it is merged manually.
• (Gitlab) Squash (mergerequest_squash, default on): sets the squash flag on the merge request, so all commits of the automated branch end up as a single commit.

Notes and limitations

• on GitLab renaming is done with a git move commit (since 3.0.0). On GitHub renaming is still done by checking in a new file and removing the old one, because the API has no move operation. This might be revisited later
• the 'Remove Source Branch' and 'Squash' merge-request options are GitLab only, GitHub does not offer an equivalent on the pull-request itself
• not all scenarios have been tested. This is a 'works for me' right now
• The GitLab server must be reachable via http or https from the production server. The GitLab api implementation is using guzzlehttp, so a proxy configuration should be possible, but I have not looked into this yet. Help in this regard is welcome
• it should be possible to add bitbucket support. This might be added at a later stage