{"id":26956532,"url":"https://github.com/xogroup/origami-logs","last_synced_at":"2025-04-03T03:30:17.094Z","repository":{"id":26815848,"uuid":"103306519","full_name":"xogroup/origami-logs","owner":"xogroup","description":"A node changelog generator that generates your changelog into a markdown file","archived":false,"fork":false,"pushed_at":"2022-12-04T04:48:56.000Z","size":962,"stargazers_count":3,"open_issues_count":25,"forks_count":1,"subscribers_count":36,"default_branch":"master","last_synced_at":"2025-03-27T13:02:09.580Z","etag":null,"topics":["changelog","changelog-generator","generator","github","node","npm"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xogroup.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-12T18:24:28.000Z","updated_at":"2019-07-26T17:50:15.000Z","dependencies_parsed_at":"2023-01-14T05:20:28.186Z","dependency_job_id":null,"html_url":"https://github.com/xogroup/origami-logs","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xogroup%2Forigami-logs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xogroup%2Forigami-logs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xogroup%2Forigami-logs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xogroup%2Forigami-logs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xogroup","download_url":"https://codeload.github.com/xogroup/origami-logs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246933131,"owners_count":20857045,"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":["changelog","changelog-generator","generator","github","node","npm"],"created_at":"2025-04-03T03:30:16.592Z","updated_at":"2025-04-03T03:30:17.041Z","avatar_url":"https://github.com/xogroup.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=center\u003e\u003cimg src=\"https://s15.postimg.cc/dk2ezad5n/logo.png\" width=\"400\"\u003e\u003c/p\u003e\n\n# Origami Logs\n\nA github changelog generator for your release notes.\n\n[![Build Status](https://travis-ci.org/xogroup/origami-logs.svg?branch=master)](https://travis-ci.org/xogroup/origami-logs)\n\n## Installation\n\n```npm i -g origami-logs```\n\n## First Step\n\nCreate a file named `.origami-logs-config.json` in the root of your project.\n\nThe file should look something like this:\n\n```\n{\n  \"github\":{\n    \"apiUrl\": \"https://git.somedomain.com/api/v3\",\n    \"token\": \"123456\",\n    \"repository\": \"Organization/repo-name\"\n  }\n}\n```\n\n## How to use\n\nTO RUN:\n\n```\nchangelog generate --tags \"startingTag,endingTag\"\n\n```\n\nTo see all other options:\n\n```\nchangelog generate --help\n```\n\n## Config Options Explained\n\nIf you wish to add other config options it might look like this:\n\n```\n{\n  \"github\":{\n    \"apiUrl\": \"https://git.somedomain.com/api/v3\",\n    \"token\": \"123456\",\n    \"repository\": \"Organization/repo-name\"\n  },\n  \"aliases\": {\n    \"enhancement\": [\n      \"feature\"\n    ]\n  },\n  \"extraLabels\": {\n    \"chore\": \"Chores Completed:\"\n  },\n  \"extras\": {\n    \"pivotal\":{\n      \"boardID\": \"1234567\"\n    }\n  }\n}\n```\n\n* `github`: *REQUIRED* The info about the given repository you wish to get the changelog format for markdown\n* `aliases`: This is to be used if you want to use your own custom labels but still conform to the enhance/bug format.\n  * IE: You might have a feature label but still want it to show `Features Implemented` on the changelog.\n* `extraLabels`: Define your own custom labels and changelog headings\n* `extras`: Where additional connections live\n  * `pivotal`: Supports linking pivotal stories in your change log assuming commits conform to the format:\n    `[#STORY_ID_HERE] Commit Message here`\n    * `boardID`: Pivotal Board ID (Found at the end of the url such as `https://www.pivotaltracker.com/n/projects/ID-HERE`)\n    \n    \n    \n## Development\n\nTo test locally run\n```\nnode cli.js generate --tags \"TAG1,TAG2\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxogroup%2Forigami-logs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxogroup%2Forigami-logs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxogroup%2Forigami-logs/lists"}