Skip to content

Commit

Permalink
fix some lint issues
Browse files Browse the repository at this point in the history
  • Loading branch information
hilmarf committed Aug 14, 2024
1 parent ed2d1b0 commit 162d082
Show file tree
Hide file tree
Showing 21 changed files with 88 additions and 94 deletions.
14 changes: 7 additions & 7 deletions .github/ISSUE_TEMPLATE/user_story.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
name: User Story
about: User Story
labels:
labels:
title: <User Story> - Title


---

**User Story**: The expressive title of your user story goes here
Expand All @@ -15,13 +13,15 @@ As a [type of user], I want to [perform some task] so that I can [achieve some g
This is a short text that just acts as an example for your user story. Please be as precise and verbose as required, so that people picking up the user story are clear about the intention and their tasks.

**Epic link**:
- #410 (just mention the number of the related epic here, it will appear as clickable link later)

- #410 (just mention the number of the related epic here, it will appear as clickable link later)

**Acceptance criteria**:

- [ ] abc should have a red button in the center of the screen
- [ ] abc should have a red button in the center of the screen
- [ ] on clicking the red button it should start to blink

**Related issues**:
- #413 (just mention the number of the related issue here, it will appear as clickable link later)
- #414 (just mention the number of the related issue here, it will appear as clickable link later)

- #413 (just mention the number of the related issue here, it will appear as clickable link later)
- #414 (just mention the number of the related issue here, it will appear as clickable link later)
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

The Open Component Model (OCM) is an open standard to describe software bills of delivery (SBOD). OCM is a technology-agnostic and machine-readable format focused on the software artifacts that must be delivered for software products.

Check out the [the main OCM project web page](https://ocm.software) to find out what OCM offers you for implementing a secure software supply chain. It is your central entry point to all kind of OCM related [docs and guides](https://ocm.software/docs/overview/about), the [OCM specification](https://ocm.software/docs/overview/specification/) and all project [github repositories](https://github.com/open-component-model). It also offers a [Getting Started](https://ocm.software/docs/getting-started/) to quickly make your hands dirty with OCM, its toolset and concepts :smiley:
Check out the [the main OCM project web page](https://ocm.software) to find out what OCM offers you for implementing a secure software supply chain. It is your central entry point to all kind of OCM related [docs and guides](https://ocm.software/docs/overview/about), the [OCM specification](https://ocm.software/docs/overview/specification/) and all project [github repositories](https://github.com/open-component-model). It also offers a [Getting Started](https://ocm.software/docs/getting-started/) to quickly make your hands dirty with OCM, its tool set and concepts :smiley:

## OCM Specifications

Expand Down Expand Up @@ -98,7 +98,7 @@ ocm --help
git-url: https://aur.archlinux.org/ocm-cli.git
package-url: https://aur.archlinux.org/packages/ocm-cli

```
```sh
# if not using a helper util
git clone https://aur.archlinux.org/ocm-cli.git
cd ocm-cli
Expand Down Expand Up @@ -142,7 +142,7 @@ podman build -t ocm --build-arg GO_VERSION=1.22 --build-arg ALPINE_VERSION=3.19

An example of how to use the `ocm` CLI in a Makefile can be found in [`examples/make`](https://ocm.software/ocm/blob/main/examples/make/Makefile).

More comprehensive examples can be taken from the [`components`](https://ocm.software/ocm/tree/main/components) contained in this repository. [Here](components/helmdemo/README.md) a complete component build including a multi-arch image is done and finally packaged into a CTF archive which can be tranported into an OCI repository. See the readme files for details.
More comprehensive examples can be taken from the [`components`](https://ocm.software/ocm/tree/main/components) contained in this repository. [Here](components/helmdemo/README.md) a complete component build including a multi-arch image is done and finally packaged into a CTF archive which can be transported into an OCI repository. See the readme files for details.

## Contributing

Expand Down
8 changes: 2 additions & 6 deletions api/ocm/extensions/accessmethods/github/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@

# Access Method `gitHub` and `github` - Github Commit Access

## Synopsis

### Synopsis

```
```yaml
type: gitHub/v1
```
Expand All @@ -19,8 +18,6 @@ GitHub repository.

Supported specification version is `v1`



### Specification Versions

#### Version `v1`
Expand All @@ -39,7 +36,6 @@ The type specific specification fields are:

The sha/id of the git commit


### Go Bindings

The go binding can be found [here](method.go)
6 changes: 3 additions & 3 deletions api/ocm/extensions/accessmethods/helm/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@

# Access Method `helm` - Helm Repository Access

## Synopsis

### Synopsis
```
```yaml
type: helm/v1
```
Provided blobs use the following media type: attribute `application/vnd.cncf.helm.chart.content.v1.tar+gzip`

### Description

This method implements the access of a Helm chart stored in a Helm chart repository.

Supported specification version is `v1`
Expand All @@ -36,7 +37,6 @@ The type specific specification fields are:

An optional keyring used to verify the chart.


### Go Bindings

The go binding can be found [here](method.go)
22 changes: 11 additions & 11 deletions api/ocm/extensions/accessmethods/localblob/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@

# Access Method `localBlob` - OCM Repository Local Blob Access

## Synopsis

### Synopsis
```
```yaml
type: localBlob/v1
```
Expand Down Expand Up @@ -37,7 +37,7 @@ The type specific specification fields are:

- **`mediaType`** *string*

The media type of the blob used to store the resource. It may add
The media type of the blob used to store the resource. It may add
format information like `+tar` or `+gzip`.

- **`referenceName`** (optional) *string*
Expand All @@ -50,7 +50,7 @@ The type specific specification fields are:
access method [`ociArtifact`](../../../../../docs/formats/accessmethods/ociArtifact.md) is stored during
some transport step as local artifact, the reference name can be set
to its original repository name. An import step into an OCI based OCM
repository may then decide to make this artifact available again as
repository may then decide to make this artifact available again as
regular OCI artifact.

- **`globalAccess`** (optional) *access method specification*
Expand All @@ -61,19 +61,18 @@ The type specific specification fields are:

For example, an OCI artifact stored as local blob
can be additionally stored as regular OCI artifact in an OCI registry.

This additional external access information can be added using
a second external access method specification.


### Go Bindings

The go binding can be found [here](method.go)

### Storage Mapping

Transporting component versions by value internalizes externally
referenced content (for example OCI image references). Those
Transporting component versions by value internalizes externally
referenced content (for example OCI image references). Those
resources will then be stored as local blobs using the media type provided by the
original blob.

Expand All @@ -84,10 +83,11 @@ by registered blob handlers.
#### Provided Blob Handlers

The standard tool set uses the following registered blob handlers:
- *Blob handler for importing oci artifact blobs into

- *Blob handler for importing oci artifact blobs into
an OCM repository mapped to an OCI registry*

In this case the oci artifact blobs will be expanded to a regular
In this case the oci artifact blobs will be expanded to a regular
OCI artifact taking the optional `referenceName`into account.

Additional blob handlers might be registered by local incarnations.
Additional blob handlers might be registered by local incarnations.
15 changes: 8 additions & 7 deletions api/ocm/extensions/accessmethods/maven/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
# `mvn` - Maven artifacts (Java packages, jars) in a Maven (mvn) repository (e.g. mvnrepository.com)

### Synopsis
```
## Synopsis

```yaml
type: mvn/v1
```
Provided blobs use the following media type: `application/x-tgz`

### Description

This method implements the access of a resource hosted by a maven repository or a
complete resource set denoted by a GAV (GroupId, ArtifactId, Version).
This method implements the access of a resource hosted by a maven repository or a
complete resource set denoted by a GAV (GroupId, ArtifactId, Version).

### Specification Versions

Expand Down Expand Up @@ -44,8 +45,8 @@ The type specific specification fields are:

The optional extension of the Maven (mvn) artifact

If classifier/extension is given a dedicated resource is described,
otherwise the complete resource set described by a GAV.
If classifier/extension is given a dedicated resource is described,
otherwise the complete resource set described by a GAV.
Only complete resource sets can be uploaded again to a Maven repository.

#### Examples
Expand Down Expand Up @@ -86,7 +87,7 @@ resources:
access:
type: mvn
repository: https://repo1.maven.org/maven2
groupId: com.sap.cloud.sdk
groupId: com.sap.cloud.sdk
artifactId: sdk-modules-bom
version: 5.7.0
classifier: ''
Expand Down
5 changes: 3 additions & 2 deletions api/ocm/extensions/accessmethods/npm/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# `npm` - NPM packages in a NPM registry (e.g. npmjs.com)

### Synopsis
```
## Synopsis

```yaml
type: npm/v1
```
Expand Down
7 changes: 2 additions & 5 deletions api/ocm/extensions/accessmethods/ociartifact/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@

# Access Method `ociArtifact` and `ociRegistry` - OCI Artifact Access

## Synopsis

### Synopsis

```
```yaml
type: ociArtifact/v1
```
Expand All @@ -24,8 +23,6 @@ This method implements the access of an OCI artifact stored in an OCI registry.

Supported specification version is `v1`



### Specification Versions

#### Version `v1`
Expand Down
7 changes: 2 additions & 5 deletions api/ocm/extensions/accessmethods/ociblob/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@

# Access Method `ociBlob` - OCI Blob Access

## Synopsis

### Synopsis
```
```yaml
type: ociBlob/v1
```
Expand All @@ -14,8 +14,6 @@ This method implements the access of an OCI blob stored in an OCI repository.

Supported specification version is `v1`



### Specification Versions

#### Version `v1`
Expand All @@ -38,7 +36,6 @@ The type specific specification fields are:

The size of the blob


### Go Bindings

The go binding can be found [here](method.go)
8 changes: 3 additions & 5 deletions api/ocm/extensions/accessmethods/relativeociref/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@

# Access Method `relativeOciReference` - OCI Artifact Access in OCI-registry-based OCM Repository

## Synopsis

### Synopsis

```
```yaml
type: relativeOciReference/v1
```
Expand All @@ -30,10 +29,9 @@ the access specification.

Supported specification version is `v1`


### Specification Versions

This access method is a legacy access method formerly used to enable
This access method is a legacy access method formerly used to enable
physical replication of OCI registry content together with referenced OCI artifacts.

This should basically be done by a value transport of the component versions, because it
Expand Down
7 changes: 2 additions & 5 deletions api/ocm/extensions/accessmethods/s3/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# `s3` - Blobs in a Simple Storage System (S3)

## Synopsis

### Synopsis
```
```yaml
type: s3/v1
```
Expand All @@ -12,7 +12,6 @@ Provided blobs use the following media type: attribute `mediaType`

This method implements the access of a blob stored in an S3 bucket.


### Specification Versions

Supported specification version is `v1`
Expand All @@ -32,5 +31,3 @@ The type specific specification fields are:
- **`key`** *string*

The key of the desired blob


11 changes: 3 additions & 8 deletions api/ocm/extensions/repositories/ocireg/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@

# Repository `OCIRegistry` and `ociRegistry` - OCI Registry based OCM Repositories

## Synopsis

### Synopsis

```
```yaml
type: OCIRegistry/v1
```
Expand All @@ -15,8 +13,6 @@ a dedicated OCI repository name prefix.
Supported specification version is `v1`.



### Specification Versions

#### Version `v1`
Expand All @@ -34,9 +30,8 @@ The type specific specification fields are:
the OCI repository prefix used for the OCM repository.

- **`componentNameMapping`** (optional) *string* (deprecated)

the mapping algorithm used to map OCM component names to OCU repository names ( `urlPath` (default) or `sha256-digest`).

the mapping algorithm used to map OCM component names to OCU repository names ( `urlPath` (default) or `sha256-digest`).

### Go Bindings

Expand Down
11 changes: 6 additions & 5 deletions api/tech/signing/handlers/rsa-signingservice/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Signing Service
# Signing service

The type `rsa-signingservice` forwards the signing to a
The type `rsa-signingservice` forwards the signing to a
signing server. The calculated digest is sent as signing request together with
the used hash algorithm

Expand All @@ -11,11 +11,12 @@ It must has the field `url` with the desired server address.

The required credentials are taken from the credentials context
using the consumer id `Signingserver.gardener.cloud`.
If uses a hostpath matcher using the identity attrutes `scheme`, `hostname`,
It uses a host path matcher using the identity attributes `scheme`, `hostname`,
`port` and `pathprefix` derived from the given server URL.

The expected credential properties are:
- **`clientCert`**: the client certificate used as TLS certificate and

- **`clientCert`**: the client certificate used as TLS certificate and
to authenticate the caller.
- **`privateKey`**: the private key for the client certificate.
- **`caCerts`**: the CA used to validate the identity of the signining server.
- **`caCerts`**: the CA used to validate the identity of the signing server.
Loading

0 comments on commit 162d082

Please sign in to comment.