{"id":1711,"date":"2018-02-13T14:56:51","date_gmt":"2018-02-13T12:56:51","guid":{"rendered":"https:\/\/www.h-hennes.fr\/blog\/?p=1711"},"modified":"2018-02-13T14:56:51","modified_gmt":"2018-02-13T12:56:51","slug":"publier-des-releases-github-via-un-script","status":"publish","type":"post","link":"https:\/\/www.h-hennes.fr\/blog\/2018\/02\/13\/publier-des-releases-github-via-un-script\/","title":{"rendered":"Publier des releases github via un script"},"content":{"rendered":"<p>Pour une fois un article qui n&rsquo;est pas li\u00e9 directement \u00e0 une technologie en particulier , mais \u00e0 la plateforme de sources github.<br \/>\nJ&rsquo;ai plusieurs modules qui sont disponibles sur cette plateforme et pour lequel un clone du d\u00e9p\u00f4t ne permets pas d&rsquo;obtenir un module fonctionnel.<\/p>\n<p>Pour\u00a0 cette raison il est n\u00e9cessaire de cr\u00e9er des \u00ab\u00a0releases\u00a0\u00bb qui sont disponibles sur une page sp\u00e9cifique du d\u00e9pot ( ex:\u00a0 <a href=\"https:\/\/github.com\/nenes25\/eicaptcha\/releases\" target=\"_blank\" rel=\"noopener\">https:\/\/github.com\/nenes25\/eicaptcha\/releases<\/a> ) et sur lequel on peut mettre \u00e0 disposition une archive ( ou tout autre fichier ) associ\u00e9 \u00e0 la release \u00e0 t\u00e9l\u00e9charger :<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-1703\" src=\"https:\/\/www.h-hennes.fr\/blog\/wp-content\/uploads\/2018\/02\/eicaptcha-release.jpg\" alt=\"Ei captcha releases\" width=\"883\" height=\"348\" srcset=\"https:\/\/www.h-hennes.fr\/blog\/wp-content\/uploads\/2018\/02\/eicaptcha-release.jpg 883w, https:\/\/www.h-hennes.fr\/blog\/wp-content\/uploads\/2018\/02\/eicaptcha-release-300x118.jpg 300w, https:\/\/www.h-hennes.fr\/blog\/wp-content\/uploads\/2018\/02\/eicaptcha-release-768x303.jpg 768w\" sizes=\"auto, (max-width: 883px) 100vw, 883px\" \/><\/p>\n<p>Il est possible de faire cela manuellement directement depuis l&rsquo;interface github, mais par principe manuellement c&rsquo;est plus lent et plus souvent source d&rsquo;erreurs qu&rsquo;un script automatique.<br \/>\nNous allons donc voir comment scripter tout \u00e7a en utilisant l&rsquo;api v3 de github et curl.<\/p>\n<p>Sachant que dans mon cas j&rsquo;ai les pr\u00e9requis suivants :<\/p>\n<ul>\n<li>environnement linux ou wsl ( voir tuto : <a href=\"https:\/\/www.h-hennes.fr\/blog\/2016\/08\/21\/alternative-a-wampserver-windows-bash\/\">Alternative \u00e0 wampserver : windows bash<\/a>)<\/li>\n<li>git renseign\u00e9 dans le path<\/li>\n<\/ul>\n<p>Je pense qu&rsquo;il est possible de faire l&rsquo;ensemble de la proc\u00e9dure ci-dessous via un script bash, mais pour moi c&rsquo;\u00e9tait plus facile de le faire en php.<\/p>\n<p>Le script n\u00e9cessitera 3 fichiers situ\u00e9s dans un m\u00eame emplacement :<\/p>\n<ul>\n<li>config.php \/\/(optionnel)<\/li>\n<li>create_release.sh \/\/Fichier shell<\/li>\n<li>create_release.php \/\/ Fichier php<\/li>\n<\/ul>\n<p>Le fichier <em>config.php<\/em> contiendra uniquement les identifiants d&rsquo;acc\u00e8s \u00e0 github.<br \/>\n( Dans le cas d&rsquo;un script priv\u00e9 vous pouvez tout \u00e0 fait les int\u00e9grer directement dans le script )<\/p>\n<pre lang=\"php\" escaped=\"true\">&lt;?php \r\n$github_user = 'githubuser'; \r\n$github_password = 'githubpassword';\r\n<\/pre>\n<p>Le fichier <em>create_release.sh<\/em> est tr\u00e8s basique :<br \/>\nil cr\u00e9\u00e9 le tag git et le pousse sur github puis lance le script php<\/p>\n<pre lang=\"bash\">#! \/bin\/bash\r\n\r\nif [ -z \"$1\" ]\r\n  then\r\n    echo \"Please provide version number\"\r\nfi\r\n\r\nversion=$1\r\n\r\n#Cr\u00e9ation du tag git et on le pousse en ligne \r\ngit tag $version\r\ngit push --tags\r\n\r\n#Lancement du script php qui se charge des autres t\u00e2ches\r\nphp create_release.php $version\r\n<\/pre>\n<p>Tout la logique de livraison de la release est r\u00e9alis\u00e9e dans le fichier <em>create_release.php<\/em><\/p>\n<pre lang=\"php\" escaped=\"true\">&lt;?php\r\nrequire_once dirname(__FILE__).'\/config.php';\r\n\r\n$baseApiUrl = 'https:\/\/api.github.com\/repos\/userName\/RepoName\/'; \/\/Url de base du d\u00e9pot\r\n\r\n\/\/On v\u00e9rifie qu'un num\u00e9ro de release est pass\u00e9 au script\r\nif ($argc &lt; 2) { exit(\"Please give a release number \\n\"); } \/\/On v\u00e9rifie que le num\u00e9ro $release = $argv[1]; echo \"Check if the release exists \\n\"; $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $baseApiUrl.'releases\/tags\/'.$release); $curlGlobalOptions = array( CURLOPT_USERAGENT =&gt; $github_user,\r\n    CURLOPT_USERNAME =&gt; $github_user,\r\n    CURLOPT_PASSWORD =&gt; $github_password,\r\n    CURLOPT_RETURNTRANSFER =&gt; true, \/\/Response in variable\r\n);\r\n\r\n\/\/Curl options\r\ncurl_setopt_array($ch, $curlGlobalOptions);\r\n\r\n$content = curl_exec($ch);\r\n$info    = curl_getinfo($ch);\r\ncurl_close($ch);\r\n\r\n\/\/Si le tag existe d\u00e9j\u00e0 inutile de continuer le script\r\nif ($info['http_code'] == 200) {\r\n    echo \"this tag already exists \\n\";\r\n    exit('end of the script');\r\n}\r\n\r\n\/\/Sinon cr\u00e9ation de la release\r\necho \"Creation of the release \\n\";\r\n$releaseDatas = array(\r\n    \"tag_name\" =&gt; $release,\r\n    \"target_commit\" =&gt; 'master', \/\/ Mettre ici la branche cible\r\n    \"name\" =&gt; $release,\r\n    \"body\" =&gt; \"Description de la release \".$relase.' see changelog',\r\n    \/\/Passer \u00e0 true pour debug\r\n    \"draft\" =&gt; false,\r\n    \"prerelease\" =&gt; false,\r\n);\r\n\r\n$curlDraft = curl_init();\r\ncurl_setopt_array($curlDraft, $curlGlobalOptions);\r\ncurl_setopt($curlDraft, CURLOPT_URL, $baseApiUrl.'releases');\r\ncurl_setopt($curlDraft, CURLOPT_POSTFIELDS, json_encode($releaseDatas));\r\n\r\n$draftExec = curl_exec($curlDraft);\r\n$draftInfo = curl_getinfo($curlDraft);\r\n\r\nif ($draftInfo['http_code'] == '201') {\r\n    echo \"Release created with success \\n\";\r\n} else {\r\n    exit(\"Error during the creation of the release \\n\");\r\n}\r\ncurl_close($curlDraft);\r\n\r\n\/\/Traitement de la r\u00e9ponse\r\n$draftResponse  = json_decode($draftExec);\r\n$assetUploadUrl = str_replace('{?name,label}', '', $draftResponse-&gt;upload_url);\r\n\r\n\/\/Logique de cr\u00e9ation du fichier joint \u00e0 impl\u00e9menter\r\n\r\n\/\/Ajout de la pi\u00e8ce jointe \u00e0 la release\r\n$archive = 'test.zip';\r\necho \"Add zip archive to release \\n\";\r\n\r\n$curlUpload = curl_init();\r\ncurl_setopt_array($curlUpload, $curlGlobalOptions);\r\ncurl_setopt($curlUpload, CURLOPT_URL,$assetUploadUrl.'?name='.urlencode($archive));\r\ncurl_setopt($curlUpload, CURLOPT_HTTPHEADER,\r\n    array(\r\n    'Content-Type: application\/zip' \/\/\r\n    )\r\n);\r\ncurl_setopt($curlUpload, CURLOPT_POSTFIELDS, file_get_contents($archive));\r\n$uploadExec = curl_exec($curlUpload);\r\n$uploadInfo = curl_getinfo($curlUpload);\r\ncurl_close($curlUpload);\r\n\r\necho \"The relase is published on github \\n\";\r\n\r\n<\/pre>\n<p>Pour publier la release il suffit ensuite d&rsquo;appeler le script via la commande<\/p>\n<pre lang=\"bash\"> .\/create_release.sh 2.0.2\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"<p>Pour une fois un article qui n&rsquo;est pas li\u00e9 directement \u00e0 une technologie en particulier , mais \u00e0 la plateforme de sources github. J&rsquo;ai plusieurs modules qui sont disponibles sur cette plateforme et pour lequel un clone du d\u00e9p\u00f4t ne permets pas d&rsquo;obtenir un module fonctionnel. Pour\u00a0 cette raison il est n\u00e9cessaire de cr\u00e9er des [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"categories":[6],"tags":[516,343,74,514,515],"class_list":["post-1711","post","type-post","status-publish","format-standard","hentry","category-trucs-et-astuces","tag-api","tag-github","tag-php","tag-release","tag-sh"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/posts\/1711","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/comments?post=1711"}],"version-history":[{"count":8,"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/posts\/1711\/revisions"}],"predecessor-version":[{"id":1719,"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/posts\/1711\/revisions\/1719"}],"wp:attachment":[{"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/media?parent=1711"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/categories?post=1711"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.h-hennes.fr\/blog\/wp-json\/wp\/v2\/tags?post=1711"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}