{"id":15293434,"url":"https://github.com/literateink/quickrelease","last_synced_at":"2025-02-23T12:32:02.296Z","repository":{"id":257801990,"uuid":"861065684","full_name":"LiterateInk/QuickRelease","owner":"LiterateInk","description":"A tool that automatically bumps the version number, creates a tag, pushes the changes, and generates a GitHub release.","archived":false,"fork":false,"pushed_at":"2024-09-26T21:20:23.000Z","size":45,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-25T12:55:52.098Z","etag":null,"topics":["github","release","release-automation","tag","version"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/LiterateInk.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-21T22:53:25.000Z","updated_at":"2024-09-28T23:05:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"6266e684-d481-4dd5-bb9c-65fe45208e5e","html_url":"https://github.com/LiterateInk/QuickRelease","commit_stats":{"total_commits":31,"total_committers":1,"mean_commits":31.0,"dds":0.0,"last_synced_commit":"6d0a78939c394b2b86f985520be6e343d8b8fccf"},"previous_names":["literateink/quickrelease"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LiterateInk%2FQuickRelease","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LiterateInk%2FQuickRelease/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LiterateInk%2FQuickRelease/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LiterateInk%2FQuickRelease/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LiterateInk","download_url":"https://codeload.github.com/LiterateInk/QuickRelease/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240317340,"owners_count":19782384,"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":["github","release","release-automation","tag","version"],"created_at":"2024-09-30T16:48:45.711Z","updated_at":"2025-02-23T12:32:02.241Z","avatar_url":"https://github.com/LiterateInk.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Quick Release\n\nA simple CLI tool to quickly release a new version of a LiterateInk library implementation.\n\nOf course, this is only useful for LiterateInk libraries and is only meant to be used by the maintainers of the libraries.\n\n## Motivation\n\nIn some implementations, such as `js`, we had custom tools to do this but it was only bound to that specific implementation. For example, `release-it` for the `js` implementation. But, I wanted a tool that could be used in any implementation without doing any extra config, work or setup.\n\nSo, we created this tool to automate the process without any configuration or setup. It's a simple CLI tool that can be used in any of our library repositories to quickly release a new version.\n\n## Installation\n\nYou can only install it by building it from source.\nMake sure you have `cargo` and `rust` installed.\n\n```bash\ncargo build --release\nsudo mv ./target/release/quick-release /usr/local/bin/ink-quick-release\n\n# Here, the command is `ink-quick-release`\n# In my shell profile, I like to add an alias:\n#\n# alias ink-qr=\"ink-quick-release\"\n```\n\nNote that the `mv` step only works on Linux and macOS. You might have to manually copy the binary to the correct path on Windows or even add the path to the binary to your `PATH` environment variable.\n\n## Usage\n\nBe in a LiterateInk repository, in an implementation branch (such as `js` or `kotlin`) and you can directly run the command.\n\n```bash\nink-quick-release\n```\n\nIt'll ask you for the type of bump you want for the new version, and then it'll create a new commit and tag and push it to the implementation branch.\n\nIt'll also redirect you to the GitHub page to create a new release with the tag, release name and the release notes - generated using a `git log`.\n\n\n## Uninstallation\n\nYou can simply remove the binary and it'll be gone.\nIt doesn't create any other files or directories, so you don't have to worry about that.\n\n```bash\nsudo rm /usr/local/bin/ink-quick-release\n```\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliterateink%2Fquickrelease","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fliterateink%2Fquickrelease","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliterateink%2Fquickrelease/lists"}