Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zheng-bote/gha_increment_semver
Github Action to increment the given semantic version
https://github.com/zheng-bote/gha_increment_semver
github-actions semver
Last synced: about 1 month ago
JSON representation
Github Action to increment the given semantic version
- Host: GitHub
- URL: https://github.com/zheng-bote/gha_increment_semver
- Owner: Zheng-Bote
- License: mit
- Created: 2024-09-12T15:03:03.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-17T17:59:23.000Z (about 2 months ago)
- Last Synced: 2024-10-14T16:21:21.323Z (about 1 month ago)
- Topics: github-actions, semver
- Language: Shell
- Homepage:
- Size: 48.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
increment SemVer
GH Action ti increment the given semantic version
[Report Issue](https://github.com/Zheng-Bote/repo-template/issues) [Request Feature](https://github.com/Zheng-Bote/repo-template/pulls)
[](https://choosealicense.com/licenses/mit/)
**Table of Contents**
- [Description](#description)
- [Features](#features)
- [Status](#status)
- [Installation](#installation)
- [Dependencies](#dependencies)
- [folder structure](#folder-structure)
- [Usage/Examples](#usageexamples)
- [input / output Examples](#input--output-examples)
- [API Reference](#api-reference)
- [Parameters](#parameters)
- [Documentation](#documentation)
- [Github Page](#github-page)
- [Screenshots](#screenshots)
- [Authors and License](#authors-and-license)
- [License](#license)
- [Authors](#authors)
- [Code Contributors](#code-contributors)
## Description
description of this
### Features
- \[x] works as designed
- \[ ] no bugs
## Status
[](https://github.com/Zheng-Bote/gha_increment_semver/actions/workflows/repo-create_tree_readme.yml)
[](https://github.com/Zheng-Bote/gha_increment_semver/actions/workflows/repo-actions_docu.yml)
[](https://github.com/Zheng-Bote/gha_increment_semver/actions/workflows/repo-create_doctoc.yml)
## Installation
bla bla
### Dependencies
bla bla
### folder structure
```
.
├── .github
│ └── workflows
│ ├── repo-actions_docu.yml
│ ├── repo-create_doctoc.yml
│ ├── repo-create_tree_readme.yml
│ └── repo-increment_semver.yml
├── LICENSE
├── README.md
├── action.yml
├── entrypoint.sh
└── tree.bak
2 directories, 9 files
```
## Usage/Examples
```html
under constrcution
```
## input / output Examples
| version-fragment | current-version | | output |
| ---------------- | --------------- | --- | -------------- |
| major | 2.11.7 | | 3.0.0 |
| major | v2.11.7 | | 3.0.0 |
| major | 2.11.7-alpha3 | | 3.0.0 |
| major | 2.11.7-alpha.3 | | 3.0.0 |
| feature | 2.11.7 | | 2.12.0 |
| feature | 2.11.7-alpha3 | | 2.12.0 |
| feature | 2.11.7-alpha.3 | | 2.12.0 |
| bug | 2.11.7 | | 2.11.8 |
| bug | 2.11.7-alpha3 | | 2.11.8 |
| bug | 2.11.7-alpha.3 | | 2.11.8 |
| alpha | 2.11.7 | | 2.11.7-alpha.1 |
| alpha | 2.11.7-alpha3 | | 2.11.7-alpha.4 |
| alpha | 2.11.7-alpha.3 | | 2.11.7-alpha.4 |
| beta | 2.11.7 | | 2.11.7-beta.1 |
| beta | 2.11.7-alpha3 | | 2.11.7-beta.1 |
| beta | 2.11.7-alpha.3 | | 2.11.7-beta.1 |
| pre | 2.11.7 | | 2.11.7-pre.1 |
| pre | 2.11.7-alpha3 | | 2.11.7-pre.1 |
| pre | 2.11.7-alpha.3 | | 2.11.7-pre.1 |
| rc | 2.11.7 | | 2.11.7-rc.1 |
| rc | 2.11.7-alpha3 | | 2.11.7-rc.1 |
| rc | 2.11.7-alpha.3 | | 2.11.7-rc.1 |
## API Reference
### Parameters
| Parameter | Type | Description |
| :----------- | :------- | :----------------------------------- |
| `name` | `string` | _Optional_ name-of-copyright-holder |
| `created` | `string` | _Optional_ |
| `version` | `string` | _Optional_ \ |
| `link_left` | `string` | _Optional_ link-to-contact-page |
| `link_right` | `string` | _Optional_ link-to-legal-notice-page |
## Documentation
```mermaid
graph TD;
Workflow-. parameter .->Callable_Workflow;
Callable_Workflow-- parameter -->Action;
```
### Github Page
[](https://www.github.com/Zheng-Bote)
see also:
> \[!NOTE]
> Useful information that users should know, even when skimming content.
> \[!TIP]
> Helpful advice for doing things better or more easily.
> \[!IMPORTANT]
> Key information users need to know to achieve their goal.
> \[!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
> \[!CAUTION]
> Advises about risks or negative outcomes of certain actions.
## Screenshots
## Authors and License
### License
MIT License
Copyright (c) 2024 ZHENG Robert
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
https://choosealicense.com/licenses/mit/
### Authors
- [](https://www.github.com/Zheng-Bote)
## Code Contributors
[](https://www.github.com/Zheng-Bote)
:vulcan_salute: