Skip to content

Commit 203a3e7

Browse files
eksrhaeksrha
authored
add zip and tgz options to release assets (#211)
1 parent f570221 commit 203a3e7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+3217
-1430
lines changed

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ APPENDIX: How to apply the Apache License to your work.
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [2022] [eksrha]
189+
Copyright [2025] [Eike Haller]
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

‎README.md‎

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
# Awesome CI
1010

11-
**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](https://semver.org/). The required version number is created with the correct naming of the branch prefix.
11+
**Description**: Awesome CI is the smart connection between your pipeline for continuous integration and GitHub. The focus is on the release process, followed by the version management of [SemVer](https://semver.org/). The required version number is created with the correct naming of the branch prefix.
1212

1313
- **Technology stack**: This tool is written in golang
1414
- **Status**: Stable.
@@ -19,43 +19,41 @@
1919
- Jenkins Pipelines
2020
- **Sweet Spot**: If you use GitHub or GitHub Enterprise and GitHub Actions, you can use awesome-ci to its full potential!
2121

22-
**ToDos**:
22+
## Getting Started
2323

24-
- more documentation
25-
- more tests (at least 80% coverage)
26-
- implement GitLab Api
27-
28-
> Info: GitLab is currently not supported
24+
You can use this tool in your CI pipeline or locally on your command line. Just [download](https://github.com/fullstack-devops/awesome-ci/releases/latest/download/awesome-ci) the most recently released version and get started.
2925

3026
## Usage
3127

32-
You can use this tool in your CI pipeline or locally on your command line. Just [download](https://github.com/fullstack-devops/awesome-ci/releases/latest/download/awesome-ci) 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](https://fullstack-devops.github.io/awesome-ci/docs/examples) of the documentation. If an example is not included, please feel free to inquire about a related [issue](https://github.com/fullstack-devops/awesome-ci/issues/new/choose).
28+
To integrate Awesome CI into your pipeline, follow these steps:
3329

34-
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](https://github.com/fullstack-devops/awesome-ci/issues/new/choose).
30+
1. Utilize the github action [fullstack-devops/awesome-ci-action](https://github.com/fullstack-devops/awesome-ci-action) to install Awesome CI.
31+
2. Configure your pipeline to use Awesome CI.
32+
3. Use the any command to interact with Awesome CI.
3533

36-
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](https://fullstack-devops.github.io/awesome-ci/docs/questions_and_answers) section before asking a question. You can find frequently asked questions there too.
34+
You can find more information on how to integrate Awesome CI into your pipeline in the [manual](https://fullstack-devops.github.io/awesome-ci/).
3735

38-
## Documentation
36+
## Examples
3937

40-
[See the manual](https://fullstack-devops.github.io/awesome-ci/) for setup, usage instructions and a lot more. (the documentation is still rising)
38+
You can find several examples of how to use Awesome CI in the [examples section](https://fullstack-devops.github.io/awesome-ci/docs/examples) of the documentation.
4139

42-
## Getting help
40+
## Frequently Asked Questions
4341

44-
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
45-
You can find frequently asked questions directly in the "Questions and Answers" section.
42+
You can find frequently asked questions in the [Questions and Answers](https://fullstack-devops.github.io/awesome-ci/docs/questions_and_answers) section of the documentation.
4643

47-
## Getting involved
44+
## Getting Help
4845

49-
- [CONTRIBUTING](docs/CONTRIBUTING.md)
46+
If you have questions, concerns, or bug reports, please file an issue in this repository's Issue Tracker.
5047

51-
---
48+
## Contributing
5249

53-
## Open source licensing info
50+
If you want to contribute to Awesome CI, please read the [CONTRIBUTING](docs/CONTRIBUTING.md) guide.
5451

55-
1. [LICENSE](LICENSE)
52+
## License
5653

57-
---
54+
Awesome CI is licensed under the Apache License, Version 2.0. You can find the license file [here](LICENSE).
5855

59-
## Credits and references
56+
## Credits
6057

6158
- [SemVer](https://semver.org/)
59+
- [Cobra CLI](https://github.com/spf13/cobra)

‎docs/docs/01-overview.md‎

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Overview
44

55
# Welcome to the Awesome CI!
66

7-
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.
7+
This project is the smart connection between your pipeline for continuous integration and your version management like 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.
88

99
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.
1010

@@ -23,7 +23,7 @@ If you need an example for your pipeline you can find it in the sidebar under th
2323

2424
:::
2525

26-
### Supported naming rules and effects on the version
26+
## Supported naming rules and effects on the version
2727

2828
The patching of the version only takes effect if the merged branch begins with the following aliases, for example: `feature/my-awesome-feature`
2929

@@ -41,22 +41,27 @@ The tailing `/` behind the alias is **always** requiered!
4141
see also [override specialties](#override-specialties)
4242
:::
4343

44-
![awesome-ci release process](/img-awesome-ci/release-process.drawio.svg "awesome-ci release process")
45-
![awesome-ci workflow](/img-awesome-ci/aci-workflow.drawio.png "awesome-ci workflow")
44+
![awesome-ci release process](/img/release-process.drawio.svg "awesome-ci release process")
45+
![awesome-ci workflow](/img/aci-workflow.drawio.png "awesome-ci workflow")
4646

4747
:::tip
48-
Awesoce CI automatically detects your environment. Supported are **Jenkins**, **GitHub Actions** and ~~GitLab CI~~
48+
Awesoce CI automatically detects your environment. Supported are **Jenkins Pipelines** and **GitHub Actions**
4949
:::
5050

51-
### Override specialties
51+
## Override specialties
5252

5353
To set some attributes during developement you can comment a pullrequest.
5454

55-
### Requiered and optional environment variables
55+
| command | description |
56+
| ----------------------------- | ------------------------------------------------------------- |
57+
| `aci_patch_level: major` | create a major version bump |
58+
| `aci_version_override: 2.1.0` | set the version to 2.1.0 using only semver compatible syntax! |
59+
60+
## Requiered and optional environment variables
5661

5762
List of all environmental variables used per CES (code execution service).
5863

59-
#### GitHub Actions
64+
### GitHub Actions
6065

6166
| Environment variable | Description | Status | Requiered |
6267
| -------------------- | -------------------------------------------------- | ------------- | :-------: |
@@ -65,16 +70,7 @@ List of all environmental variables used per CES (code execution service).
6570
| `GITHUB_REPOSITORY` | The owner and repository name. | set by runner | true |
6671
| `GITHUB_TOKEN` | Must provided in workflow as `env:` (see examples) | set by runner | true |
6772

68-
#### GitLab Workflows
69-
70-
| Environment variable | Description | Status | requiered |
71-
| -------------------- | -------------------------------------------------------------- | ------------- | :-------: |
72-
| `CI` | Is set by GitLab Workflows and returns `true` | set by runner | true |
73-
| `CI_SERVER_URL` | Will only be set by using the GitHub Plugin. | set by runner | true |
74-
| `CI_PROJECT_URL` | The owner and repository name. | set by runner | true |
75-
| `CI_JOB_TOKEN` | Must provided in pipeline as `env.GITHUB_TOKEN` (see examples) | set by runner | true |
76-
77-
#### Jenkins Pipeline
73+
### Jenkins Pipeline
7874

7975
| Environment variable | Description | Status | requiered |
8076
| -------------------- | -------------------------------------------------------------- | ---------------------------- | :-------: |

docs/docs/02-cli/awesome-ci.md renamed to docs/docs/02-CLI/awesome-ci.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ awesome-ci [flags]
3030
* [awesome-ci release](./awesome-ci_release) - Manage GitHub releases with ease
3131
* [awesome-ci transform](./awesome-ci_transform) - transform given input to json
3232

33-
###### Auto generated by spf13/cobra on 5-Dec-2024
33+
###### Auto generated by spf13/cobra on 17-Feb-2025

docs/docs/02-cli/awesome-ci_connect.md renamed to docs/docs/02-CLI/awesome-ci_connect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ awesome-ci connect [flags]
3535
* [awesome-ci connect github](./awesome-ci_connect_github) - connect initial to a GitHub or GitHub Enterprise
3636
* [awesome-ci connect remove](./awesome-ci_connect_remove) - remove all persisted connection files and secrets
3737

38-
###### Auto generated by spf13/cobra on 5-Dec-2024
38+
###### Auto generated by spf13/cobra on 17-Feb-2025

docs/docs/02-cli/awesome-ci_connect_check.md renamed to docs/docs/02-CLI/awesome-ci_connect_check.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ awesome-ci connect check [flags]
2525

2626
* [awesome-ci connect](./awesome-ci_connect) - Create an encrypted .rc file to persistently connect to GitHub or GitHub Enterprise
2727

28-
###### Auto generated by spf13/cobra on 5-Dec-2024
28+
###### Auto generated by spf13/cobra on 17-Feb-2025

docs/docs/02-cli/awesome-ci_connect_github.md renamed to docs/docs/02-CLI/awesome-ci_connect_github.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ awesome-ci connect github [flags]
2828

2929
* [awesome-ci connect](./awesome-ci_connect) - Create an encrypted .rc file to persistently connect to GitHub or GitHub Enterprise
3030

31-
###### Auto generated by spf13/cobra on 5-Dec-2024
31+
###### Auto generated by spf13/cobra on 17-Feb-2025

docs/docs/02-cli/awesome-ci_connect_remove.md renamed to docs/docs/02-CLI/awesome-ci_connect_remove.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ awesome-ci connect remove [flags]
2525

2626
* [awesome-ci connect](./awesome-ci_connect) - Create an encrypted .rc file to persistently connect to GitHub or GitHub Enterprise
2727

28-
###### Auto generated by spf13/cobra on 5-Dec-2024
28+
###### Auto generated by spf13/cobra on 17-Feb-2025

docs/docs/02-cli/awesome-ci_parse.md renamed to docs/docs/02-CLI/awesome-ci_parse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ awesome-ci parse [flags]
2828
* [awesome-ci parse version](./awesome-ci_parse_version) - Validate the given version string against semver syntax
2929
* [awesome-ci parse yaml](./awesome-ci_parse_yaml) - parse a yaml string or file
3030

31-
###### Auto generated by spf13/cobra on 5-Dec-2024
31+
###### Auto generated by spf13/cobra on 17-Feb-2025

docs/docs/02-cli/awesome-ci_parse_json.md renamed to docs/docs/02-CLI/awesome-ci_parse_json.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ awesome-ci parse json [flags]
2828

2929
* [awesome-ci parse](./awesome-ci_parse) - inspect and parse JSON and YAML files to retrieve values, similar to jq with additional features
3030

31-
###### Auto generated by spf13/cobra on 5-Dec-2024
31+
###### Auto generated by spf13/cobra on 17-Feb-2025

0 commit comments

Comments
 (0)