| Name | gh-semantic-release JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | Trigger a semantic release with the click of a button |
| upload_time | 2025-02-19 04:57:02 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | BSD-3 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# gh-semantic-release
Trigger a semantic release with the click of a button
**THIS PROJECT IS CURRENTLY UNDER DEVELOPMENT**
## Concept
- A tool to trigger a GitHub release
- CLI tool
- GitHub action published
- GitHub workflow template provided
- Parse semantic commits to generate structured changelog
- A GitHub workflow template will be provided
- Automatic version bump
### Workflows
1. Trigger a workflow dispatch with a release name to automatically generate a new GitHub release.
- The version will be bumped based on a configurable heuristic (breaking => major, feat => minor, etc.)
- The changelog/release summary will be constructed from the parsed commits
2. Configurable via `pyproject.toml`
```toml
[tool.gh-semantic-release]
types = ["build", "chore", "ci", "docs", "feat"] # ...
```
3. Installed via `pypi`
Write your own bespoke release behavior using either the CLI or by extending `scottzach1.semantic_release` with your
own custom python code.
Raw data
{
"_id": null,
"home_page": null,
"name": "gh-semantic-release",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Zac Scott <zac.scott11@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/64/ab/55bf5c7e21cbd38e5393f1a7d8fe5729f18920d1a0bfb8fdcdc013dfaa77/gh_semantic_release-0.0.1.tar.gz",
"platform": null,
"description": "# gh-semantic-release\n\nTrigger a semantic release with the click of a button\n\n**THIS PROJECT IS CURRENTLY UNDER DEVELOPMENT**\n\n## Concept\n\n- A tool to trigger a GitHub release\n - CLI tool\n - GitHub action published\n - GitHub workflow template provided\n- Parse semantic commits to generate structured changelog\n- A GitHub workflow template will be provided\n- Automatic version bump\n\n### Workflows\n\n1. Trigger a workflow dispatch with a release name to automatically generate a new GitHub release.\n\n - The version will be bumped based on a configurable heuristic (breaking => major, feat => minor, etc.)\n - The changelog/release summary will be constructed from the parsed commits\n\n2. Configurable via `pyproject.toml`\n\n ```toml\n [tool.gh-semantic-release]\n types = [\"build\", \"chore\", \"ci\", \"docs\", \"feat\"] # ...\n ```\n\n3. Installed via `pypi`\n\n Write your own bespoke release behavior using either the CLI or by extending `scottzach1.semantic_release` with your\n own custom python code.\n",
"bugtrack_url": null,
"license": "BSD-3",
"summary": "Trigger a semantic release with the click of a button",
"version": "0.0.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d72e757867d139a4d322afa6247fedf6c14aec14a5ae1b777c3726c08e859e16",
"md5": "e73a951cfdea8e9815ceba4dcd0a627f",
"sha256": "4f0b6a5ee552c284e73f94a0bcbadb03fa2eee92487fd489d1a4b5c8a3d4ccbb"
},
"downloads": -1,
"filename": "gh_semantic_release-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e73a951cfdea8e9815ceba4dcd0a627f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 2966,
"upload_time": "2025-02-19T04:57:00",
"upload_time_iso_8601": "2025-02-19T04:57:00.535722Z",
"url": "https://files.pythonhosted.org/packages/d7/2e/757867d139a4d322afa6247fedf6c14aec14a5ae1b777c3726c08e859e16/gh_semantic_release-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "64ab55bf5c7e21cbd38e5393f1a7d8fe5729f18920d1a0bfb8fdcdc013dfaa77",
"md5": "e64450715bcc9ed54f0f2c9a8ac3f48f",
"sha256": "703fbc0f6c8f22787f751727727aaf676a4de7c50315a7670245c859130f0bd6"
},
"downloads": -1,
"filename": "gh_semantic_release-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "e64450715bcc9ed54f0f2c9a8ac3f48f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 2519,
"upload_time": "2025-02-19T04:57:02",
"upload_time_iso_8601": "2025-02-19T04:57:02.493692Z",
"url": "https://files.pythonhosted.org/packages/64/ab/55bf5c7e21cbd38e5393f1a7d8fe5729f18920d1a0bfb8fdcdc013dfaa77/gh_semantic_release-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-19 04:57:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gh-semantic-release"
}
