README
¶
Awesome CI
Description: This project is the smart connection between your pipeline for continuous integration and your version management like GitLab or GitHub. The focus is on the release process, followed by the version management of SemVer. The required version number is created with the correct naming of the branch prefix.
- Technology stack: This tool is written in golang
- Status: Stable.
- Requests and Issues: Please feel free to open an question or feature request in the Issue Board.
- Supported environments:
- GitHub & GitHub Enterprise
- GitHub actions
- Jenkins Pipelines
- Sweet Spot: If you use GitHub or GitHub Enterprise and GitHub Actions, you can use awesome-ci to its full potential!
ToDos:
- more documentation
- more tests (at least 80% coverage)
- implement GitLab Api
Info: GitLab is currently not supported
Usage
You can use this tool in your CI pipeline or locally on your command line. Just download the most recently released version and get started. You can find out how to integrate this into your respective pipeline in the following document. There are also several examples in the examples section of the documentation. If an example is not included, please feel free to inquire about a related issue.
If more functionality is needed you can just open a problem in this project and of course bugs can be fixed in the same way by filing a bug report.
If you have any questions, you can find a form on the issue board. First, make sure your question is already in the Questions and Answers section before asking a question. You can find frequently asked questions there too.
Documentation
See the manual for setup, usage instructions and a lot more. (the documentation is still rising)
Getting help
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker. You can find frequently asked questions directly in the "Questions and Answers" section.
Directories