fullstack-devops/awesome-ci

This tool makes your CI workflow easier! Using SemVer and naming conventions saves a lot of time when creating a release.

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

awesome-ci's Issues

Feature: release message/ body

Is your feature request related to a problem? Please describe.
no

Describe the solution you'd like
in the release creation/ publish command, an additional flag for a release message (file or string)

Describe alternatives you've considered
none

Additional context

Bug: cannot get PR INFO from the first PullRequest

Description
If I have newly created repository without any release, I cannot get infos for the first PullRequest.
Instead I get an eror message: No PR found in merge message pls make shure this regex matches: .#([0-9]+).

Expected behavior
Information about the first PullRequest should be displayed.

Feature make a pre-release on request

Idea: create a pre release on the subcommand createRelease with the -preRelease Flag

Feature: export uploaded artifacts as env

Is your feature request related to a problem? Please describe.
none

Describe the solution you'd like
after uploading an asset to a release, the Download-URL should be exposed.

Describe alternatives you've considered
none

Additional context
none

Feature get PR number in branch

Idea: get the pull-request number while branch is an PR

This needs an web request and is not accessible via git cli

Bug: SCMLayer.GetLatestReleaseVersion nil pointer

Describe the bug
Nil pointer

Your environment/setup

• GitHub Actions
• GitLab CI
• Jenkins CI

How is this tool installed

• Container

Are all environment variables set? See README.md

• yes
• no

To Reproduce
Paste your executed command here:

Paste your Pipeline log (this is optional, make shure no secrets are visable):

Run awesome-ci -v pr info -n 50
time="2023-03-02T12:32:12Z" level=info msg="detected ces type: github_runner"
time="2023-03-02T12:32:12Z" level=info msg="evaluated pull request number 50"
time="2023-03-02T12:32:12Z" level=info msg="found pull request 'Bump commons-text from 1.9 to 1.10.0' with given number 50"
time="2023-03-02T12:32:12Z" level=trace msg="got PR information from scm-portal-layer"
time="2023-03-02T12:32:12Z" level=trace msg="completed PR standard information to:  {50 em*** pm*** bugfix   f5a776e56f2d41e79c5208fd77150b92425e1559 f5a776e5 dependabot/maven/org.apache.commons-commons-text-1.10.0 3167bad4a1c7cded99e30ff9d0cb0c4ffdc12e7d}"
time="2023-03-02T12:32:12Z" level=trace msg="comment help instructions to issue"
time="2023-03-02T12:32:13Z" level=trace msg="commented help instructions to issue"
time="2023-03-02T12:32:13Z" level=trace msg="read comments from pr/mr and looking for overrides"
time="2023-03-02T12:32:13Z" level=trace msg="read comments from pr/mr complete conclusions (if nil no override), version: <nil>, patchLevel: <nil>"
time="2023-03-02T12:32:13Z" level=trace msg="get latest release, if any"
time="2023-03-02T12:32:13Z" level=trace msg="querying release page 1"
time="2023-03-02T12:32:13Z" level=trace msg="found 38 releases at page 1 begin with mapping..."
time="2023-03-02T12:32:13Z" level=trace msg="####### next page: 0"
time="2023-03-02T12:32:13Z" level=trace msg="ended with paging through releases"
time="2023-03-02T12:32:13Z" level=trace msg="open local git repository..."
time="2023-03-02T12:32:13Z" level=trace msg="...opened local git repository"
time="2023-03-02T12:32:13Z" level=trace msg="[0.0.1 7.0.0 10.5.1 10.5.2 10.5.3 10.5.4 10.5.5 10.5.6 10.5.7 10.6.0 10.7.0 10.7.1 10.7.2 10.7.3 10.7.4 10.7.5 10.7.6 10.8.0 10.8.1 10.8.2 10.8.3 10.9.0 10.9.1 10.10.0 10.11.0 10.11.1 10.12.0 10.12.1 10.13.0 10.14.0 10.15.0 10.15.1 10.16.0 10.17.0 10.18.0 10.18.1 10.19.0 10.20.0]"
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x0 pc=0xabb3fc]

goroutine 1 [running]:
github.com/fullstack-devops/awesome-ci/internal/app/awesome-ci/scm-portal.SCMLayer.GetLatestReleaseVersion({{0xc6f480, 0xc00020ab70}, {{0xcf5149, 0xd}, {0xc0000300eb, 0x5a}, 0xc000129be0}})
	/home/runner/work/awesome-ci/awesome-ci/internal/app/awesome-ci/scm-portal/release.go:24 +0x15c
github.com/fullstack-devops/awesome-ci/internal/app/awesome-ci/scm-portal.SCMLayer.GetPrInfos({{0xc6f480, 0xc00020ab70}, {{0xcf5149, 0xd}, {0xc0000300eb, 0x5a}, 0xc000129be0}}, 0x0?, {0x0, 0x0})

Expected behavior
no nil pointer

Additional context
Add any other context about the problem here.

Feature: check asstes before upload (new command)

Is your feature request related to a problem? Please describe.
awesome-ci publishes release even asstes are not available

Describe the solution you'd like
awesome-ci should fail

Describe alternatives you've considered

Additional context

Feature create pre-release

Idea: When starting the ci for your software, a pre-release is created. After a successful build, this pre-resease will be converted into a normal release. This prevents the versions from being mixed up and overlapping if several features are built in parallel or if there are long pipeline runtimes.

Bug: -patchLevel ist ignored when running a release -dry-run

Feature autodetection environment Jenkins

Idea: awesome-ci should detect the environmet automatically, if it's running inside an Jenkins Pipeline

Feature: source pr infos not from merge message

 const prs = await repo.listPullRequests(
        { "state": "all", "sort": "updated", "direction": "desc", "per_page": "10" })
    const pull = prs.data.find(p => p.merge_commit_sha === sha1);

Feature: comment commands in pr

Is your feature request related to a problem? Please describe.
no

Describe the solution you'd like
When opening an issue and the env Variable ACI_SILENT=true is not set, there should be an comment in the pr for command options

Describe alternatives you've considered

Additional context
related to #57

Feature Hotfix or Bugfix on old version

Feature: version_override in comments

Feature create Tags

Idea: create lightweight and annotated Tags + push them to repo (optional)

Feature autodetection environment GitLab

Idea: awesome-ci should detect the environmet automatically, if it's running inside an GitLab CI