Skip to content

Commit

Permalink
chore: pin version in tour guide to avoid regeneration
Browse files Browse the repository at this point in the history
  • Loading branch information
@jakobmoellerdev
jakobmoellerdev committed Nov 12, 2024
1 parent a1890c2 commit 4e01b00
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 18 deletions.
18 changes: 10 additions & 8 deletions examples/lib/tour/01-getting-started/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,9 @@ Now, we have a look at the latest version. It is
the last one in the list.

```go
cv, err := c.LookupVersion(versions[len(versions)-1])
// to retrieve the latest version use
// cv, err := c.LookupVersion(versions[len(versions)-1])
cv, err := c.LookupVersion("0.17.0")
if err != nil {
return errors.Wrapf(err, "cannot get latest version")
}
Expand Down Expand Up @@ -168,32 +170,32 @@ differ, because the code always describes the latest version):

```text
resources of the latest version:
version: 0.18.0-rc.1
version: 0.17.0
provider: ocm.software
1: name: ocmcli
extra identity: "architecture"="amd64","os"="linux"
resource type: executable
access: Local blob sha256:74fdf71c5467cacd1cb09d15d6ad4944d60cc8efa1d704a91c337e54dcd03fbc[]
access: Local blob sha256:03a45dcde67ba565fe806cb5db67da3387f772f7c50af711a0edd6f802570c04[]
2: name: ocmcli
extra identity: "architecture"="arm64","os"="linux"
resource type: executable
access: Local blob sha256:d0022850cce685d48ca589b3b59913ecbc3572f7f5082bca5c086a4bf2b47c5a[]
access: Local blob sha256:5a622634ae43cf03eac91079389d83266891d1f9b2d8a3884cef6fe639180324[]
3: name: ocmcli
extra identity: "architecture"="arm64","os"="darwin"
resource type: executable
access: Local blob sha256:1161fc38d0fe78ba3be97783f8676a46afa2baf57c199f937798f791cc4961d3[]
access: Local blob sha256:1482fe5b764e3a86cf96704d7a839ad7e53dcbfd4f5fce5405abffb1962153dd[]
4: name: ocmcli
extra identity: "architecture"="amd64","os"="darwin"
resource type: executable
access: Local blob sha256:33074ce5cc079ea4fc1dbcc7bd54c27cc93f0e188d9ad8c56ba642c4ba6744af[]
access: Local blob sha256:805f181aff48511eea12c699ed1bbcee8bdc4c5168924e81058aff8715946875[]
5: name: ocmcli
extra identity: "architecture"="amd64","os"="windows"
resource type: executable
access: Local blob sha256:2fbac39d7772ae1cf209aca5bb5efdbb6b91e83aede9464c52304c3ccebb4f67[]
access: Local blob sha256:20839c68bf0c4cf99444d78ebb93f53358fa9e95fe806f186220bd21d520efa7[]
6: name: ocmcli-image
extra identity:
resource type: ociImage
access: OCI artifact ghcr.io/open-component-model/ocm/ocm.software/ocmcli/ocmcli-image:0.18.0-rc.1@sha256:3ba3e8c075f7f91e851ec3ce53da2347fe464b3ac33c6d65cf89a459193bb5cb
access: OCI artifact ghcr.io/open-component-model/ocm/ocm.software/ocmcli/ocmcli-image:0.17.0@sha256:16fb52a1cb11c867bd058f4124dea53fbab94229842cc14b52653c2e80b1cede
```

Resources have some metadata, like their identity and a resource type.
Expand Down
4 changes: 3 additions & 1 deletion examples/lib/tour/01-getting-started/example.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,9 @@ func GettingStarted() error {
// Now, we have a look at the latest version. it is
// the last one in the list.
// --- begin lookup version ---
cv, err := c.LookupVersion(versions[len(versions)-1])
// to retrieve the latest version use
// cv, err := c.LookupVersion(versions[len(versions)-1])
cv, err := c.LookupVersion("0.17.0")
if err != nil {
return errors.Wrapf(err, "cannot get latest version")
}
Expand Down
16 changes: 8 additions & 8 deletions examples/lib/tour/07-resource-management/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -270,28 +270,28 @@ function before finishing.
The final output of this example looks like:

```yaml
versions for component ocm.software/ocmcli: 0.1.0-alpha.2, 0.1.0-dev, 0.3.0-dev, 0.3.0-rc.2, 0.3.0-rc.3, 0.3.0, 0.4.0-dev, 0.4.0, 0.4.1, 0.4.2, 0.4.3, 0.5.0, 0.6.0, 0.7.0, 0.8.0, 0.9.0, 0.10.0, 0.11.0, 0.12.0, 0.12.1, 0.13.0, 0.14.0, 0.15.0, 0.16.0, 0.16.1, 0.16.2, 0.17.0-rc.1, 0.17.0, 0.18.0-rc.1
versions for component ocm.software/ocmcli: 0.1.0-alpha.2, 0.1.0-dev, 0.3.0-dev, 0.3.0-rc.2, 0.3.0-rc.3, 0.3.0, 0.4.0-dev, 0.4.0, 0.4.1, 0.4.2, 0.4.3, 0.5.0, 0.6.0, 0.7.0, 0.8.0, 0.9.0, 0.10.0, 0.11.0, 0.12.0, 0.12.1, 0.13.0, 0.14.0, 0.15.0, 0.16.0, 0.16.1, 0.16.2, 0.17.0-rc.1, 0.17.0, 0.18.0-rc.1, 0.18.0-rc.2
looking up resources of the latest version:
version: 0.18.0-rc.1
version: 0.17.0
provider: ocm.software
*** resources:
1: extra identity: "architecture"="amd64","name"="ocmcli","os"="linux"
resource type: executable
access: Local blob sha256:74fdf71c5467cacd1cb09d15d6ad4944d60cc8efa1d704a91c337e54dcd03fbc[]
access: Local blob sha256:03a45dcde67ba565fe806cb5db67da3387f772f7c50af711a0edd6f802570c04[]
2: extra identity: "architecture"="arm64","name"="ocmcli","os"="linux"
resource type: executable
access: Local blob sha256:d0022850cce685d48ca589b3b59913ecbc3572f7f5082bca5c086a4bf2b47c5a[]
access: Local blob sha256:5a622634ae43cf03eac91079389d83266891d1f9b2d8a3884cef6fe639180324[]
3: extra identity: "architecture"="arm64","name"="ocmcli","os"="darwin"
resource type: executable
access: Local blob sha256:1161fc38d0fe78ba3be97783f8676a46afa2baf57c199f937798f791cc4961d3[]
access: Local blob sha256:1482fe5b764e3a86cf96704d7a839ad7e53dcbfd4f5fce5405abffb1962153dd[]
4: extra identity: "architecture"="amd64","name"="ocmcli","os"="darwin"
resource type: executable
access: Local blob sha256:33074ce5cc079ea4fc1dbcc7bd54c27cc93f0e188d9ad8c56ba642c4ba6744af[]
access: Local blob sha256:805f181aff48511eea12c699ed1bbcee8bdc4c5168924e81058aff8715946875[]
5: extra identity: "architecture"="amd64","name"="ocmcli","os"="windows"
resource type: executable
access: Local blob sha256:2fbac39d7772ae1cf209aca5bb5efdbb6b91e83aede9464c52304c3ccebb4f67[]
access: Local blob sha256:20839c68bf0c4cf99444d78ebb93f53358fa9e95fe806f186220bd21d520efa7[]
6: extra identity: "name"="ocmcli-image"
resource type: ociImage
access: OCI artifact ghcr.io/open-component-model/ocm/ocm.software/ocmcli/ocmcli-image:0.18.0-rc.1@sha256:3ba3e8c075f7f91e851ec3ce53da2347fe464b3ac33c6d65cf89a459193bb5cb
access: OCI artifact ghcr.io/open-component-model/ocm/ocm.software/ocmcli/ocmcli-image:0.17.0@sha256:16fb52a1cb11c867bd058f4124dea53fbab94229842cc14b52653c2e80b1cede
```
5 changes: 4 additions & 1 deletion examples/lib/tour/07-resource-management/example.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"strings"

"github.com/mandelsoft/goutils/errors"

"ocm.software/ocm/api/utils/blobaccess/blobaccess"

"ocm.software/ocm/api/ocm"
Expand Down Expand Up @@ -211,7 +212,9 @@ func GatherResources(ctx ocm.Context, factory ResourceFactory) ([]Resource, erro
// Now, we have a look at the latest version. it is
// the last one in the list.
// --- begin lookup version ---
cv, err := c.LookupVersion(versions[len(versions)-1])
// to retrieve the latest version use
// cv, err := c.LookupVersion(versions[len(versions)-1])
cv, err := c.LookupVersion("0.17.0")
if err != nil {
return nil, errors.Wrapf(err, "cannot get latest version")
}
Expand Down

0 comments on commit 4e01b00

Please sign in to comment.