{"id":19114996,"url":"https://github.com/namelesscoder/typo3-repository-gizzle","last_synced_at":"2025-04-30T22:51:59.774Z","repository":{"id":27979141,"uuid":"31472558","full_name":"NamelessCoder/typo3-repository-gizzle","owner":"NamelessCoder","description":"TYPO3 GitHub Repository Releaser","archived":false,"fork":false,"pushed_at":"2015-03-12T01:47:22.000Z","size":216,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-30T22:51:54.568Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NamelessCoder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-28T18:52:39.000Z","updated_at":"2017-01-31T07:25:05.000Z","dependencies_parsed_at":"2022-08-23T13:50:23.846Z","dependency_job_id":null,"html_url":"https://github.com/NamelessCoder/typo3-repository-gizzle","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NamelessCoder%2Ftypo3-repository-gizzle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NamelessCoder%2Ftypo3-repository-gizzle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NamelessCoder%2Ftypo3-repository-gizzle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NamelessCoder%2Ftypo3-repository-gizzle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NamelessCoder","download_url":"https://codeload.github.com/NamelessCoder/typo3-repository-gizzle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251795424,"owners_count":21645020,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T04:45:15.896Z","updated_at":"2025-04-30T22:51:59.746Z","avatar_url":"https://github.com/NamelessCoder.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"https://release.namelesscoder.net/typo3-repository-gizzle-logo.svg\"\n     alt=\"TYPO3 GitHub Repository Releaser\" style=\"width: 100%;\" /\u003e\n\n[![Build Status](https://img.shields.io/jenkins/s/https/jenkins.fluidtypo3.org/typo3-repository-gizzle.svg?style=flat-square)](https://jenkins.fluidtypo3.org/job/typo3-repository-gizzle/) [![Coverage Status](https://img.shields.io/coveralls/NamelessCoder/typo3-repository-gizzle.svg?style=flat-square)](https://coveralls.io/r/NamelessCoder/typo3-repository-gizzle)\n\n\nThis project allows any GitHub-hosted repository containing a TYPO3 CMS\nextension to be released to the official TYPO3 Extension Repository\n(hereafter referred to as TER) by adding a very simple GitHub web hook.\n\nThe official endpoint of this service is `https://release.namelesscoder.net`\nbut you are welcome to install this package on your own and use that\ninstallation location as endpoint.\n\nThe project uses Gizzle to listen for GitHub events and uses Gizzle TYPO3\nplugins to do the actual uploading. Internally, the Gizzle TYPO3 plugins\nuse the TYPO3 Repository Client.\n \n* https://github.com/NamelessCoder/gizzle\n* https://github.com/NamelessCoder/gizzle-typo3-plugins\n* https://github.com/NamelessCoder/typo3-repository-client\n\nRequirements\n------------\n\n* A **public** GitHub repository containing your extension's source code.\n* For custom endpoints only: access to the `git` and `php` CLI commands as\n  well as some way to serve the `web/index.php` file through HTTP/HTTPS.\n\nInstallation\n------------\n\n1. Edit the settings of your repository and locate \"Webhooks \u0026 services\".\n2. Click \"Add webhook\" to create a new hook.\n3. In \"Payload URL\", fill in the endpoint URL you wish to use. The default\n   URL is `https://release.namelesscoder.net`\n4. Add your unique credentials and information to the URL. There are two\n   possible URL formats:\n   * If your GitHub repository name is **not the same** as your TER extension\n     key, a URL like `https://release.namelesscoder.net/my_extension/user:password`.\n     must be used - which will release the repository as key `my_extension`.\n   * If your GitHub repository is already named the same as your extension\n     key you can leave out that part of the URL and use a shorter URL like\n     `https://release.namelesscoder.net/user:password`.\n   * Alternatively, if you feel more comfortable with it and the endpoint\n     supports it, use `https://username:password@release.namelesscoder.net/my_extension`.\n     This method only works if the server supports the `authnz_external_module`\n     or corresponding external authentications - see below.\n5. Enter a \"Secret\". We use a fixed secret for now - enter the text `typo3rocks`.\n6. Leave the \"Which events...\" selectors as-is. We only need the `push` event.\n\nUnfortunately there is no way to isolate an event that only gets dispatched\nwhen you create new tags - which is why we have to listen to all `push`es.\nWe simply ignore those that do not refer to a tag.\n\nSecurity\n--------\n\nBecause your credentials are included in the URL, we are doing the following\non the default endpoint and you should definitely do the same if you create one:\n\n* The URL is protected by SSL.\n* The full URL of requests is never logged.\n\nPlease note that this credentials-in-URL approach is considered *temporary* and\nis only implemented because there currently are no other ways. The end goal is\nto use a token solution both for the \"Secret\" that is currently fixed, as well\nas for the credentials that must be passed to TER. The former will be solved\nby creating an official GitHub Service but the latter will depend on work that\nhas to be done on TER or even TYPO3 SSO itself.\n\nIf your web server supports it (Apache does via `authnz_external_module`) then\nyou can register an external authenticator (change/move the path if needed):\n\n```\n\u003cIfModule authnz_external_module\u003e\n    DefineExternalAuth fake environment /var/www/release.namelesscoder.net/fake-auth.sh\n\u003c/IfModule\u003e\n```\n\n...which goes in your virtual host or root server configuration. The `fake-auth.sh`\nscript is a dummy that allows any username and password to be authenticated -\nand if done this way, this project will instead read those (fake) credentials.\nThis means you can specify the credentials to use when uploading to TER, as\n`https://username:password@release.namelesscoder.net/my_extension`.\n\nUsage\n-----\n\nTo create a new TER release from your GitHub repository simply create a new\ntag and push it. The uploader will then use the message of the commit you tag\nas the upload comment on TER. To create and push a new tag:\n\n```\ngit tag 1.2.3\ngit push origin 1.2.3\n```\n\nWhich creates a new tag called `1.2.3` and pushes it to the remote called `origin`.\n\nViewing results\n---------------\n\nThe results of uploads triggered this way can be read in two different places:\n\n* The **publicly available** message that the release was created gets added\n  as a comment to the commit that was HEAD of the repository when tagging.\n* The **privately available** debugging information can be viewed by locating\n  the \"Webhooks \u0026 services\" panel as described in the installation section, and\n  clicking the URL that was added. A short list of most recent transactions is\n  displayed and clicking each one will allow you to read any technical errors.\n\nBehavior\n--------\n\nThe behavior of this plugin is very easily described:\n\n1. Whenever you push to GitHub, we receive an event.\n2. We analyse the Payload HEAD:\n   * If it is not a new tag we exit.\n   * If it is a new tag we upload a new release.\n3. We set a \"success\" status flag on the commit you tagged.\n4. We add a comment to the commit you tagged, saying it was released to TER.\n5. We assign a bit of debugging information and send our response to GitHub.\n\nThe whole process should only take a couple of seconds, depending on how large\nyour extension is. If at any point during the process an error occurs, it is\ncaught and can be inspected in the web hook response as described above.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnamelesscoder%2Ftypo3-repository-gizzle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnamelesscoder%2Ftypo3-repository-gizzle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnamelesscoder%2Ftypo3-repository-gizzle/lists"}