Skip to content

Commit

Permalink
[create-pull-request] automated change
Browse files Browse the repository at this point in the history
  • Loading branch information
schmidtw committed Jan 18, 2024
1 parent 826aa54 commit c5196ad
Showing 1 changed file with 33 additions and 2 deletions.
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,38 @@ This workflow does the following things automatically:

# 🔰 Reusable Workflows 🔰

* [1: CI Workflow](#1-ci-workflow) ( [📄](.github/workflows/ci.yml) )
* [1: Auto Releaser](#1-auto-releaser) ( [📄](.github/workflows/auto-releaser.yml) )
* [2: CI Workflow](#2-ci-workflow) ( [📄](.github/workflows/ci.yml) )

## 1: CI Workflow
## 1: Auto Releaser
## Golang Automatic Patch Releaser Sample

```yaml
# SPDX-FileCopyrightText: 2024 Comcast Cable Communications Management, LLC
# SPDX-License-Identifier: Apache-2.0
---
name: 'Automatically relase patch versions.'

on:
schedule: # Run every day at 12:00 UTC
- cron: '0 12 * * *'
workflow_dispatch:

jobs:
release:
uses: ./.github/workflows/auto-releaser.ym
```

### Inputs

| # | Required | Type | Name | Default | Description |
| :--- | :---: | :---: | :--- | :--- | :--- |
| 1 | | string | branch | main | Branch to release from. |
| 2 | | string | patch-list | fix, bugfix, perf, refactor, test, tests, chore | Comma separated list of commit types that should trigger a patch release. |



## 2: CI Workflow
## Golang CI Workflow Sample

```yaml
Expand Down Expand Up @@ -179,6 +208,7 @@ jobs:
| 32 | | boolean | style-skip | false | Skip building the gofmt check. |
| 33 | | boolean | tests-race | true | If set to "true" (default), race condition checking will be performed during unit tests. Otherwise no race condition checking will be done. |
| 34 | | boolean | tests-skip | false | Skip running the unit tests. |
| 35 | | boolean | upload-skip | false | Skip uploading the artifacts. |



Expand All @@ -187,6 +217,7 @@ jobs:




## Workflow Development

There are three special directories:
Expand Down

0 comments on commit c5196ad

Please sign in to comment.