AI experiments with DevDot (copy as markdown, llm.txt, etc) #13877
ci.yml
on: pull_request
Run Tests 🧪
1m 22s
Lint
1m 0s
Annotations
4 errors and 2 warnings
src/views/docs-view/loaders/__tests__/file-system.test.ts > FileSystemLoader > generates static props from mdx file:
src/views/docs-view/loaders/__tests__/file-system.test.ts#L56
Error: Snapshot `FileSystemLoader > generates static props from mdx file 1` mismatched
- Expected
+ Received
@@ -5,10 +5,75 @@
"page_title": "Introduction",
},
"githubFileUrl": "https://github.com/hashicorp/waypoint/blob/main/website/src/views/docs-view/loaders/__fixtures__/index.mdx",
"mdxSource": {
"compiledSource": Any<String>,
+ "rawContent": "
+ # Introduction to Vault
+
+ Welcome to the introduction guide to HashiCorp Vault! This guide is the best
+ place to get started with Vault. This guide covers what Vault is, what problems
+ it can solve, how it compares to existing software, and contains a quick start
+ for using Vault.
+
+ If you are already familiar with the basics of Vault, the
+ [documentation](/docs) provides a better reference guide for all
+ available features as well as internals.
+
+ ## What is Vault?
+
+ Vault is a tool for securely accessing _secrets_. A secret is anything that you
+ want to tightly control access to, such as API keys, passwords, or certificates.
+ Vault provides a unified interface to any secret, while providing tight access
+ control and recording a detailed audit log.
+
+ A modern system requires access to a multitude of secrets: database credentials,
+ API keys for external services, credentials for service-oriented architecture
+ communication, etc. Understanding who is accessing what secrets is already very
+ difficult and platform-specific. Adding on key rolling, secure storage, and
+ detailed audit logs is almost impossible without a custom solution. This is
+ where Vault steps in.
+
+ Examples work best to showcase Vault. Please see the
+ [use cases](/docs/use-cases).
+
+ The key features of Vault are:
+
+ - **Secure Secret Storage**: Arbitrary key/value secrets can be stored
+ in Vault. Vault encrypts these secrets prior to writing them to persistent
+ storage, so gaining access to the raw storage isn't enough to access
+ your secrets. Vault can write to disk, [Consul](https://www.consul.io),
+ and more.
+
+ - **Dynamic Secrets**: Vault can generate secrets on-demand for some
+ systems, such as AWS or SQL databases. For example, when an application
+ needs to access an S3 bucket, it asks Vault for credentials, and Vault
+ will generate an AWS keypair with valid permissions on demand. After
+ creating these dynamic secrets, Vault will also automatically revoke them
+ after the lease is up.
+
+ - **Data Encryption**: Vault can encrypt and decrypt data without storing
+ it. This allows security teams to define encryption parameters and
+ developers to store encrypted data in a location such as SQL without
+ having to design their own encryption methods.
+
+ - **Leasing and Renewal**: All secrets in Vault have a _lease_ associated
+ with them. At the end of the lease, Vault will automatically revoke that
+ secret. Clients are able to renew leases via built-in renew APIs.
+
+ - **Revocation**: Vault has built-in support for secret revocation. Vault
+ can revoke not only single secrets, but a tree of secrets, for example
+ all secrets read by a specific user, or all secrets of a particular type.
+ Revocation assists in key rolling as well as locking down systems in the
+ case of an intrusion.
+
+ ## Next Steps
+
+ See the page on [Vault use cases](/docs/use-cases) to see the multiple ways
+ Vault can be used. Then, continue onwards with the [Vault foundations
+ tutorials](https://developer.hashicorp.com/vault/tutorials/get-started) to use
+ Vault to read, write, and create real secrets and see how it works in practice.",
"scope": {
"version": "latest",
},
},
"navData": Any<Array>,
❯ src/views/docs-view/loaders/__tests__/file-system.test.ts:56:17
|
src/views/docs-view/loaders/__tests__/file-system.test.ts > FileSystemLoader > uses provided githubFileUrl if provided:
src/views/docs-view/loaders/__tests__/file-system.test.ts#L93
Error: Snapshot `FileSystemLoader > uses provided githubFileUrl if provided 1` mismatched
- Expected
+ Received
@@ -5,10 +5,75 @@
"page_title": "Introduction",
},
"githubFileUrl": "https://hashicorp.com/src/views/docs-view/loaders/__fixtures__/index.mdx",
"mdxSource": {
"compiledSource": Any<String>,
+ "rawContent": "
+ # Introduction to Vault
+
+ Welcome to the introduction guide to HashiCorp Vault! This guide is the best
+ place to get started with Vault. This guide covers what Vault is, what problems
+ it can solve, how it compares to existing software, and contains a quick start
+ for using Vault.
+
+ If you are already familiar with the basics of Vault, the
+ [documentation](/docs) provides a better reference guide for all
+ available features as well as internals.
+
+ ## What is Vault?
+
+ Vault is a tool for securely accessing _secrets_. A secret is anything that you
+ want to tightly control access to, such as API keys, passwords, or certificates.
+ Vault provides a unified interface to any secret, while providing tight access
+ control and recording a detailed audit log.
+
+ A modern system requires access to a multitude of secrets: database credentials,
+ API keys for external services, credentials for service-oriented architecture
+ communication, etc. Understanding who is accessing what secrets is already very
+ difficult and platform-specific. Adding on key rolling, secure storage, and
+ detailed audit logs is almost impossible without a custom solution. This is
+ where Vault steps in.
+
+ Examples work best to showcase Vault. Please see the
+ [use cases](/docs/use-cases).
+
+ The key features of Vault are:
+
+ - **Secure Secret Storage**: Arbitrary key/value secrets can be stored
+ in Vault. Vault encrypts these secrets prior to writing them to persistent
+ storage, so gaining access to the raw storage isn't enough to access
+ your secrets. Vault can write to disk, [Consul](https://www.consul.io),
+ and more.
+
+ - **Dynamic Secrets**: Vault can generate secrets on-demand for some
+ systems, such as AWS or SQL databases. For example, when an application
+ needs to access an S3 bucket, it asks Vault for credentials, and Vault
+ will generate an AWS keypair with valid permissions on demand. After
+ creating these dynamic secrets, Vault will also automatically revoke them
+ after the lease is up.
+
+ - **Data Encryption**: Vault can encrypt and decrypt data without storing
+ it. This allows security teams to define encryption parameters and
+ developers to store encrypted data in a location such as SQL without
+ having to design their own encryption methods.
+
+ - **Leasing and Renewal**: All secrets in Vault have a _lease_ associated
+ with them. At the end of the lease, Vault will automatically revoke that
+ secret. Clients are able to renew leases via built-in renew APIs.
+
+ - **Revocation**: Vault has built-in support for secret revocation. Vault
+ can revoke not only single secrets, but a tree of secrets, for example
+ all secrets read by a specific user, or all secrets of a particular type.
+ Revocation assists in key rolling as well as locking down systems in the
+ case of an intrusion.
+
+ ## Next Steps
+
+ See the page on [Vault use cases](/docs/use-cases) to see the multiple ways
+ Vault can be used. Then, continue onwards with the [Vault foundations
+ tutorials](https://developer.hashicorp.com/vault/tutorials/get-started) to use
+ Vault to read, write, and create real secrets and see how it works in practice.",
"scope": {
"version": "latest",
},
},
"navData": Any<Array>,
❯ src/views/docs-view/loaders/__tests__/file-system.test.ts:93:17
|
src/views/docs-view/loaders/__tests__/remote-content.test.ts > RemoteContentLoader > generates props from remote data:
src/views/docs-view/loaders/__tests__/remote-content.test.ts#L162
Error: Snapshot `RemoteContentLoader > generates props from remote data 1` mismatched
- Expected
+ Received
@@ -5,10 +5,89 @@
"page_title": "Waypoint Commands (CLI)",
},
"githubFileUrl": "https://github.com/hashicorp/waypoint/blob/main/website/content/commands/index.mdx",
"mdxSource": {
"compiledSource": Any<String>,
+ "rawContent": "# Waypoint Commands (CLI)
+
+ Waypoint is controlled via a very easy to use command-line interface (CLI). Waypoint
+ is only a single command-line application: `waypoint`. This application then takes a
+ subcommand such as `artifact` or `deployment`. The complete list of subcommands is in
+ the navigation to the left.
+
+ The waypoint CLI is a well-behaved command line application. In erroneous cases, a
+ non-zero exit status will be returned. It also responds to -h and --help as you'd most
+ likely expect.
+
+ To view a list of the available commands at any time, just run waypoint with no arguments:
+
+ ```shell-session
+ $ waypoint
+ Usage: waypoint [-version] [-help] [-autocomplete-(un)install] <command> [args]
+
+ Common commands:
+ build Build a new versioned artifact from source
+ deploy Deploy a pushed artifact
+ release Release a deployment
+ up Perform the build, deploy, and release steps for the app
+
+ Other commands:
+ artifact Artifact and build management
+ auth-method Auth method management
+ config Application configuration management
+ context Server access configurations
+ deployment Deployment creation and management
+ destroy Delete all the resources created for an app
+ docs Show documentation for components
+ exec Execute a command in the context of a running application instance
+ fmt Rewrite waypoint.hcl configuration to a canonical format
+ hostname Application URLs
+ init Initialize and validate a project
+ install Install the Waypoint server to Kubernetes, Nomad, or Docker
+ logs Show log output from the current application deployment
+ project Project management
+ runner Runner management
+ server Server management
+ ui Open the web UI
+ user User information and management
+ version Prints the version of this Waypoint CLI
+ ```
+
+ To get help for any specific command, pass the -h flag to the relevant subcommand.
+ For example, to see help about the up subcommand:
+
+ ```shell-session
+ $ waypoint up -h
+ Usage: waypoint up [options]
+
+ Perform the build, deploy, and release steps for the app.
+
+ Global Options:
+
+ -workspace=<string>
+ Workspace to operate in. Defaults to 'default'. The default is default.
+
+ Operation Options:
+
+ -label=<key=value>
+ Labels to set for this operation. Can be specified multiple times.
+
+ -remote
+ True to use a remote runner to execute. This defaults to false unless
+ 'runner.default' is set in your configuration. The default is false.
+
+ -remote-source=<key=value>
+ Override configurations for how remote runners source data. This is
+ specified to the data source type being used in your configuration. This
+ is used for example to set a specific Git ref to run against.
+ ```
+
+ Running `waypoint -autocomplete-install` will add the waypoint autocomplete capability
+ so you can do `waypoint <tab>` on commands. Running `waypoint -autocomplete-uninstall`
+ will remove it. Please note that this will modify your shell init script, so you will
+ need to reload your shell.
+ ",
"scope": {
"version": "latest",
},
},
"navData": Any<Array>,
❯ src/views/docs-view/loaders/__tests__/remote-content.test.ts:162:17
|
Run Tests 🧪
Process completed with exit code 1.
|
Lint
ubuntu-latest pipelines will use ubuntu-24.04 soon. For more details, see https://github.com/actions/runner-images/issues/10636
|
Run Tests 🧪
ubuntu-latest pipelines will use ubuntu-24.04 soon. For more details, see https://github.com/actions/runner-images/issues/10636
|