{"id":18447489,"url":"https://github.com/revsys/vinnie","last_synced_at":"2025-04-08T00:32:08.272Z","repository":{"id":45593214,"uuid":"201088808","full_name":"revsys/vinnie","owner":"revsys","description":"Vinnie The Versioner","archived":false,"fork":false,"pushed_at":"2025-03-03T00:48:32.000Z","size":78,"stargazers_count":12,"open_issues_count":6,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-17T11:05:10.668Z","etag":null,"topics":["docker","ops","python3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/revsys.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"AUTHORS.txt","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-07T16:39:01.000Z","updated_at":"2025-03-03T00:42:40.000Z","dependencies_parsed_at":"2024-11-06T07:13:32.166Z","dependency_job_id":"f2b47896-e8b3-4938-a1c6-dbbf8168c840","html_url":"https://github.com/revsys/vinnie","commit_stats":{"total_commits":59,"total_committers":7,"mean_commits":8.428571428571429,"dds":0.4067796610169492,"last_synced_commit":"be9e2d628457d6556e1cfe988779ccb482c9f63a"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revsys%2Fvinnie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revsys%2Fvinnie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revsys%2Fvinnie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revsys%2Fvinnie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/revsys","download_url":"https://codeload.github.com/revsys/vinnie/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247755440,"owners_count":20990617,"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":["docker","ops","python3"],"created_at":"2024-11-06T07:13:29.393Z","updated_at":"2025-04-08T00:32:08.265Z","avatar_url":"https://github.com/revsys.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vinnie the Versioner\n\n## Overview\n\n`vinnie` is a small utility to handle [semantic versioning](https://semver.org/)\nusing only git tags.  This can be done either manually or as part of CI.\n\n## Motivation\n\nThe motivation for building Vinnie is somewhat small and trivial. Many existing\ntools force you to keep the **current version** in a file in your git repository\nwhich often means that during a CI build process you generate a commit that\nis simply incrementing the version number.  By no means is this the end of the\nworld, but we realized we could fairly safely just use git tags as the storage\nmechanism for the current version.\n\n## Usage\n\nCalling `vinnie` on its own prints the help.\n\n`vinnie version` prints the current version to stdout.\n\n`vinnie (patch|minor|major)` increments the version number of the given level, creates the tag, and pushes it. You can skip pushing by using `vinnie --no-push`\n\n`vinnie next (patch|minor|major)` determines the _next_ version number of the\ngiven level and prints it to stdout.\n\n`vinnie replace /path/to/file` will replace the marker (default of `__VINNIE_VERSION__`)\nin this file with the current version.\n\n`vinnie show-config` dumps the current configuration Vinnie is operating with,\nmostly for debugging.\n\n## Nonsemantic versioning\n\nVinnie also supports not using [semver](https://semver.org/) by just using an\nincrementing integer (v1, v2, ... v47) if you wish.  To do that you need to\nalways pass in the option `--no-semver` and then the only incrementing\ncommand to use is bump.\n\n```shell\n$ vinnie --no-semver bump\n```\n\n## Options\n\n`--repo` set the filesystem path to the root of the git checkout\n\n`--repo-url` set the URL on a supported provider for the repository\n\n`--github-token` GitHub API token\n\n`--gitlab-token` GitLab API token\n\n`--push/--no-push` push or don't push to the repo. The default is to push.\n\n`--prefix` allows you to set an optional text prefix to all version numbers, for\nexample, `vinnie --prefix=v` would create version numbers such as `v0.0.1`.\n\n`--omit-prefix` suppresses the prefix from output. The tag will be processed\nusing the prefix, but the output will just contain the version numbers such as\n`0.0.1`.\n\n`--semver/--no-semver` sets whether or not you want to use semantic versioning\nor just an incrementing integer. The default is to use semver.\n\n`--current-version` in some situations it's nice to be able to just tell Vinnie\nwhat the current version is, this option allows you to do that.  In this case,\nVinnie ignores whatever versions actually exist as tags on the repository.\n\n## Environment Variables\n\nVinnie also listens for environment variables if you would prefer to use those\nthe following map to the given option\n\n- `VINNIE_REPO_PATH` sets `--repo`\n- `VINNIE_REPO_URL` sets `--repo-url`\n- `VINNIE_GITHUB_TOKEN` sets `--github-token`\n- `VINNIE_GITLAB_TOKEN` sets `--gitlab-token`\n- `VINNIE_REPO_PUSH` sets `--push`\n- `VINNIE_PREFIX` sets `--prefix`\n- `VINNIE_OMIT_PREFIX` sets `--omit-prefix`\n- `VINNIE_CURRENT_VERSION` sets `--current-version`\n- `VINNIE_GIT_REMOTE` sets `--remote`\n- `VINNIE_VERSION_MARKER` sets `--marker`\n- `VINNIE_SEMVER=False` sets `--no-semver`\n- `VINNIE_SEMVER=True` sets `--semver` which is the default\n\n## Examples\n\nLet's start with a simple example:\n\n```shell\n$ cd my-git-repo\n$ vinnie version\n0.0.0\n$ vinnie patch\n0.0.1\n```\n\nOr maybe you want to use a prefix on with a project that already has been\nusing semver in a pattern of `vX.Y.Z` in tags, you would then just need to do:\n\n```shell\n$ cd my-git-repo\n$ vinnie --prefix=v version\nv1.2.3\n$ vinnie --prefix=v minor\nv1.3.0\n```\n\n## Similar Projects\n\nVinnie is very similar to these other fine projects:\n\n- [bumpversion](https://pypi.org/project/bumpversion/)\n- [semver (js)](https://www.npmjs.com/package/semver)\n- [semver (python)](https://pypi.org/project/semver/)\n\n## Roadmap / TODO\n\nWe feel this is pretty feature complete, but definitely open to suggestions! \n\n## License\n\nBSD Licensed\n\n## Author\n\nOriginally written by [Frank Wiles](https://frankwiles.com) \u003cfrank@revsys.com\u003e\nand brought to you by [REVSYS](https://www.revsys.com).\n\n## Keep in touch!\n\nIf you have a question about this project, please open a GitHub issue. If you love us and want to keep track of our goings-on, here's where you can find us online:\n\n\u003ca href=\"https://revsys.com?utm_medium=github\u0026utm_source=vinnie\"\u003e\u003cimg src=\"https://pbs.twimg.com/profile_images/915928618840285185/sUdRGIn1_400x400.jpg\" height=\"50\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://twitter.com/revsys\"\u003e\u003cimg src=\"https://cdn1.iconfinder.com/data/icons/new_twitter_icon/256/bird_twitter_new_simple.png\" height=\"43\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://www.facebook.com/revsysllc/\"\u003e\u003cimg src=\"https://cdn3.iconfinder.com/data/icons/picons-social/57/06-facebook-512.png\" height=\"50\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/revsys/\"\u003e\u003cimg src=\"https://assets-cdn.github.com/images/modules/logos_page/GitHub-Mark.png\" height=\"53\" /\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevsys%2Fvinnie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frevsys%2Fvinnie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevsys%2Fvinnie/lists"}