Skip to content
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

Jump to bottom

feat(docs): update maintenance docs #269

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(docs): update maintenance docs #269

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
<!-- toc -->
- [Actions](#actions)
- [Workflows](#workflows)
- [Building](#building)
- [Implementing](#implementing)
- [Catalog](#catalog)
- [Ko build](#ko-build)
- [Docker build](#docker-build)
- [Dockerfile lint](#dockerfile-lint)
Expand Down Expand Up @@ -84,6 +87,32 @@ for configuration see [`on.workflow_call.inputs` in .github/workflows/reusable-W

-->

### Building

reusable workflows:

- use _workflow_call_ and inputs to provide parameters to the workflow
- use digests for implementing existing actions, such as `actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0`
- try to build workflow steps to fail-fast

reusable apps:

- use the main branch for implementing other reusable workflows like `GeoNet/Actions/.github/workflows/reusable-gofmt.yml@main`

GeoNet/Actions:

- use the _on.pull_request_ with setting _branches_ to _main_

repo implementation specific workflows:

- when using OIDC based functions, like AWS IAM's AssumeRoleWithWebIdentity or container image signing with cosign ensure that _permissions.contents_ is set to _read_ and _permissions.id-token_ is set to _write_

### Implementing

- use the main branch for implementing reusable workflows like `GeoNet/Actions/.github/workflows/reusable-gofmt.yml@main`

## Catalog

### Ko build

STATUS: stable
Expand Down
Loading