Promote artifact commands to stable
Signed-off-by: Matheus Pimenta <matheuscscp@gmail.com>
This commit is contained in:
@@ -33,8 +33,8 @@ import (
|
|||||||
var buildArtifactCmd = &cobra.Command{
|
var buildArtifactCmd = &cobra.Command{
|
||||||
Use: "artifact",
|
Use: "artifact",
|
||||||
Short: "Build artifact",
|
Short: "Build artifact",
|
||||||
Long: withPreviewNote(`The build artifact command creates a tgz file with the manifests
|
Long: `The build artifact command creates a tgz file with the manifests
|
||||||
from the given directory or a single manifest file.`),
|
from the given directory or a single manifest file.`,
|
||||||
Example: ` # Build the given manifests directory into an artifact
|
Example: ` # Build the given manifests directory into an artifact
|
||||||
flux build artifact --path ./path/to/local/manifests --output ./path/to/artifact.tgz
|
flux build artifact --path ./path/to/local/manifests --output ./path/to/artifact.tgz
|
||||||
|
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ import (
|
|||||||
var diffArtifactCmd = &cobra.Command{
|
var diffArtifactCmd = &cobra.Command{
|
||||||
Use: "artifact",
|
Use: "artifact",
|
||||||
Short: "Diff Artifact",
|
Short: "Diff Artifact",
|
||||||
Long: withPreviewNote(`The diff artifact command computes the diff between the remote OCI artifact and a local directory or file`),
|
Long: `The diff artifact command computes the diff between the remote OCI artifact and a local directory or file`,
|
||||||
Example: `# Check if local files differ from remote
|
Example: `# Check if local files differ from remote
|
||||||
flux diff artifact oci://ghcr.io/stefanprodan/manifests:podinfo:6.2.0 --path=./kustomize`,
|
flux diff artifact oci://ghcr.io/stefanprodan/manifests:podinfo:6.2.0 --path=./kustomize`,
|
||||||
RunE: diffArtifactCmdRun,
|
RunE: diffArtifactCmdRun,
|
||||||
|
|||||||
@@ -49,8 +49,8 @@ func newListArtifactFlags() listArtifactFlags {
|
|||||||
var listArtifactsCmd = &cobra.Command{
|
var listArtifactsCmd = &cobra.Command{
|
||||||
Use: "artifacts",
|
Use: "artifacts",
|
||||||
Short: "list artifacts",
|
Short: "list artifacts",
|
||||||
Long: withPreviewNote(`The list command fetches the tags and their metadata from a remote OCI repository.
|
Long: `The list command fetches the tags and their metadata from a remote OCI repository.
|
||||||
The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`),
|
The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`,
|
||||||
Example: ` # List the artifacts stored in an OCI repository
|
Example: ` # List the artifacts stored in an OCI repository
|
||||||
flux list artifact oci://ghcr.io/org/config/app
|
flux list artifact oci://ghcr.io/org/config/app
|
||||||
`,
|
`,
|
||||||
|
|||||||
@@ -33,8 +33,8 @@ import (
|
|||||||
var pullArtifactCmd = &cobra.Command{
|
var pullArtifactCmd = &cobra.Command{
|
||||||
Use: "artifact",
|
Use: "artifact",
|
||||||
Short: "Pull artifact",
|
Short: "Pull artifact",
|
||||||
Long: withPreviewNote(`The pull artifact command downloads and extracts the OCI artifact content to the given path.
|
Long: `The pull artifact command downloads and extracts the OCI artifact content to the given path.
|
||||||
The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`),
|
The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`,
|
||||||
Example: ` # Pull an OCI artifact created by flux from GHCR
|
Example: ` # Pull an OCI artifact created by flux from GHCR
|
||||||
flux pull artifact oci://ghcr.io/org/manifests/app:v0.0.1 --output ./path/to/local/manifests
|
flux pull artifact oci://ghcr.io/org/manifests/app:v0.0.1 --output ./path/to/local/manifests
|
||||||
`,
|
`,
|
||||||
|
|||||||
@@ -44,8 +44,8 @@ import (
|
|||||||
var pushArtifactCmd = &cobra.Command{
|
var pushArtifactCmd = &cobra.Command{
|
||||||
Use: "artifact",
|
Use: "artifact",
|
||||||
Short: "Push artifact",
|
Short: "Push artifact",
|
||||||
Long: withPreviewNote(`The push artifact command creates a tarball from the given directory or the single file and uploads the artifact to an OCI repository.
|
Long: `The push artifact command creates a tarball from the given directory or the single file and uploads the artifact to an OCI repository.
|
||||||
The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`),
|
The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`,
|
||||||
Example: ` # Push manifests to GHCR using the short Git SHA as the OCI artifact tag
|
Example: ` # Push manifests to GHCR using the short Git SHA as the OCI artifact tag
|
||||||
echo $GITHUB_PAT | docker login ghcr.io --username flux --password-stdin
|
echo $GITHUB_PAT | docker login ghcr.io --username flux --password-stdin
|
||||||
flux push artifact oci://ghcr.io/org/config/app:$(git rev-parse --short HEAD) \
|
flux push artifact oci://ghcr.io/org/config/app:$(git rev-parse --short HEAD) \
|
||||||
|
|||||||
@@ -31,8 +31,8 @@ import (
|
|||||||
var tagArtifactCmd = &cobra.Command{
|
var tagArtifactCmd = &cobra.Command{
|
||||||
Use: "artifact",
|
Use: "artifact",
|
||||||
Short: "Tag artifact",
|
Short: "Tag artifact",
|
||||||
Long: withPreviewNote(`The tag artifact command creates tags for the given OCI artifact.
|
Long: `The tag artifact command creates tags for the given OCI artifact.
|
||||||
The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`),
|
The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`,
|
||||||
Example: ` # Tag an artifact version as latest
|
Example: ` # Tag an artifact version as latest
|
||||||
flux tag artifact oci://ghcr.io/org/manifests/app:v0.0.1 --tag latest
|
flux tag artifact oci://ghcr.io/org/manifests/app:v0.0.1 --tag latest
|
||||||
`,
|
`,
|
||||||
|
|||||||
Reference in New Issue
Block a user