{"id":16791859,"url":"https://github.com/posabsolute/releasenotes","last_synced_at":"2025-10-04T11:29:00.868Z","repository":{"id":2704347,"uuid":"3698157","full_name":"posabsolute/releasenotes","owner":"posabsolute","description":"Automatic release notes using Github milestones","archived":false,"fork":false,"pushed_at":"2024-11-03T14:41:18.000Z","size":3859,"stargazers_count":60,"open_issues_count":2,"forks_count":15,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-05-20T11:07:22.805Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/posabsolute.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-03-12T18:07:25.000Z","updated_at":"2022-06-08T11:37:12.000Z","dependencies_parsed_at":"2024-12-26T03:08:00.600Z","dependency_job_id":"fa3ecc8c-3f0a-4ced-8f39-59e790e08845","html_url":"https://github.com/posabsolute/releasenotes","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/posabsolute/releasenotes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posabsolute%2Freleasenotes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posabsolute%2Freleasenotes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posabsolute%2Freleasenotes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posabsolute%2Freleasenotes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/posabsolute","download_url":"https://codeload.github.com/posabsolute/releasenotes/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posabsolute%2Freleasenotes/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263469330,"owners_count":23471503,"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-10-13T08:36:01.657Z","updated_at":"2025-10-04T11:28:55.831Z","avatar_url":"https://github.com/posabsolute.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Automatic Release notes plugin \u0026 website using GitHub milestones\n\nLets be real, creating release notes by hand is tedious, this jQuery plugin creates release notes automatically from your github milestones repository.  It comes with a nice onepage layout, but you can also integrate it in any website. It also integrates issues, labels \u0026 comments\n\n\n![Screenshot](http://www.position-absolute.com/big_ad.png)\n\nIt's a nice middleground where you can show what your team is doing without having to give github access to all your company. You can see an implemented  [example here](http://release.weddingdeck.com).\n\n\n* Since this plugin uses ajax functionalities, to view the demo your code needs to be on a web server.\n** The documentation is also available online at : http://posabsolute.github.com/releasenotes/\n\n*** If you use this plugin in production please consider *[buying me a good pint of beer!!](http://www.position-absolute.com/?p=3992)*\nDonate button is at the bottom of the page\n\n[![endorse](http://api.coderwall.com/posabsolute/endorsecount.png)](http://coderwall.com/posabsolute)\n\n\n\n## Options\n\nBy default your last 10 milestones will be shown. It uses jsonp for fetching the data from github, this is perfect for public repos.\n\n\t\t$(document).ready(function() {\n\t\t\t$(\"#releaseNotesContainer\").releaseNotes({\n\t\t\t\tmilestonesShown\t\t\t: 10,\n\t\t\t\t// If you want to show private repo\n\t\t\t\t// You need to add repo credentials in api.php\n\t\t\t\tphpApi\t\t\t\t: true,\n\t\t\t\t\tphpApiPath\t\t: '/',\n\t\t\t\tshowDescription\t\t\t: true,\n\t\t\t\tshowComments\t\t\t: true,\n\t\t\t\t// Used if phpAPI is false\n\t     \t\t\trepo\t\t\t\t\t: 'rails',\n\t     \t\t\tusername\t\t\t\t: 'rails'\n\t\t\t});\n\t\t});\n\n### milestonesShown (int)\n\nThe number of milestone the plugin will show.\n\n### phpApi (boolean)\n\nIf set to true, the release notes will be fetch in php, perfect for private repos.\n\n### phpApiPath (string) (required only if phpApi is set to true)\n\nPath to the api.php file, without the good path and the phpApi option active the plugin will fail.\n\n### showDescription (boolean)\n\nShow an issue complete description when you click on it.\n\n### showComments (boolean)\n\nWhen an issue description is shown, if this issue has comments, a Show Comments button will appear enabling the users to see this issue comments.\n\n### repo (string)\n\nYour github repo name, the plugin will fetch data from this repository.\n\n### username (string)\n\nThe github username that is attached to your repo.\n\n\n\n## Integration in other websites\n\nYou want to integrate this plugin in your website, no problem. First you need to add to your document head a couple of js and one css file. This plugin has 2 javascript dependencies, marked.js and jQuery.\n\nInclude Depencies \u0026 the plugin\n\n\t\u003cscript src=\"jquery/1.4.4/jquery.js\" type=\"text/javascript\"\u003e\u003c/script\u003e\n\t\u003cscript src=\"js/libs/marked.js\"\u003e\u003c/script\u003e\n\t\u003cscript src=\"js/releasenotes.js\"\u003e\u003c/script\u003e\n\nNext include the plugin stylesheet\n\n\t\u003clink rel=\"stylesheet\" href=\"css/releasenotes.plugin.css\"\u003e\n\nFinally extenciate and define your options in the document.ready. \n\n\t\u003cscript\u003e\n\t\t$(document).ready(function() {\n\t\t\t$(\"#releaseNotesContainer\").releaseNotes({\n\t\t\t\tmilestonesShown\t\t\t: 10,\n\t\t\t\t// If you want to show private repo\n\t\t\t\t// You need to add repo credentials in api.php\n\t\t\t\tphpApi\t\t\t\t: true,\n\t\t\t\t\tphpApiPath\t\t: '/',\n\t\t\t\tshowDescription\t\t\t: true,\n\t\t\t\tshowComments\t\t\t: true,\n\t\t\t\t// Used if phpAPI is false\n\t     \t\t\trepo\t\t\t\t\t: 'rails',\n\t     \t\t\tusername\t\t\t\t: 'rails'\n\t\t\t});\n\t\t});\n\t\u003c/script\u003e\n\nIn this example releaseNotesContainer is the div id where the plugin will be created.\n\n## Private Repository\n\nTo show release notes from a private repo, first you need to set your phpApi option to true, and to set the good phpApiPath path.\n\nNext, open api.php, there is a variable $config at the top where you will need to put your github credentials.\n\n\t$configs = array(\n\t    \"username\" =\u003e \"username\",  // Github user\n\t    \"password\" =\u003e \"password\",\t// Github user password\n\t    \"repo\"     =\u003e \"repo\"\t// Github Repositoty\n\t);\n\nSince we use a bridge to get the github data, your credentials will never be exposed to your users.\n\n\n## Limitations\n\nThe plugin works on \nFirefox 3.6+,\nSafari,\nChrome,\nIE7+\n\n\n## Licence\n\nCopyright (c) 2012 Cedric Dugas, http://www.position-absolute.com/\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\nLIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\nWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fposabsolute%2Freleasenotes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fposabsolute%2Freleasenotes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fposabsolute%2Freleasenotes/lists"}