Skip to content

Update README with section on updating existing repos to the latest workflow. #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcushines merged 3 commits into from
Nov 1, 2023
Merged

Update README with section on updating existing repos to the latest workflow. #5

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f415a9
Update README with section on updating existing repos to the latest w…
wenovus Nov 1, 2023
b414230
add example link
wenovus Nov 1, 2023
48c14c7
Update README.md
marcushines Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,21 @@
# Common CI workflows for OpenConfig Projects

## Standard Usage
## Upgrading CI Version

When updating a repository to use the latest reusable CI workflow on the main
branch, `<latest SHA>` should be used following the safest security and
stability recommendations:
https://docs.github.com/en/actions/using-workflows/reusing-workflows#calling-a-reusable-workflow

Do this by simply updating the SHA in the user repository's
`.github/workflows/go.yml` to the SHA of the current main branch
([example](https://github.com/openconfig/kne/pull/371/files#diff-678682767f2477de3e3c546746f8568b9a1942b2c647d32331d7e774b8ff8d9f)).
If you created a PR to update the reusable workflow, then this will be available
after the PR is merged.

## First-time Use

### Standard Go Usage

Copy the following into your repository's `.github/workflows/go.yml`:

Expand All @@ -16,10 +31,10 @@ on:

jobs:
go:
uses: openconfig/common-ci/.github/workflows/go.yml@v1.0.0
uses: openconfig/common-ci/.github/workflows/go.yml@<latest SHA>

linter:
uses: openconfig/common-ci/.github/workflows/linter.yml@v1.0.0
uses: openconfig/common-ci/.github/workflows/linter.yml@<latest SHA>
```

Then copy the sample linter configurations folder into your repository:
Expand All @@ -31,7 +46,7 @@ cp -r common-ci/.github/linters YOUR-REPO/.github/linters
At this point, you may wish to change the configuration of these linters to suit
your own repository.

## Basic Usage
### Basic Go Usage (for simple Go repositories)

If you do not want to maintain linter configuration, then you may use the basic
workflow, which only involves copying the following into your repository's
Expand All @@ -49,17 +64,17 @@ on:

jobs:
go:
uses: openconfig/common-ci/.github/workflows/basic_go.yml@v1.0.0
uses: openconfig/common-ci/.github/workflows/basic_go.yml@<latest SHA>
```

## Flags
### Flags

Some flags are supported for customizing the CI workflow, for example,

```yaml
jobs:
go:
uses: openconfig/common-ci/.github/workflows/basic_go.yml@v1.0.0
uses: openconfig/common-ci/.github/workflows/basic_go.yml@<latest SHA>
with:
static-analysis-excludes-regex: exampleoc
skip-gofmt: true
Expand Down