GitLab

https://handbook.gitlab.com
Admin
GitLab is a DevSecOps platform that provides version control, CI/CD, security, and collaboration...
Tokens:8,146,744
Snippets:65,223
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Agent prompt for starting a preview

Source: https://handbook.gitlab.com/handbook/about/editing-handbook

Example prompt to ask an agent to preview a page using the repository's existing local setup and provide the exact local page URL.

```text
Preview <page URL> using this repository's existing local setup.
Reuse an existing preview if available, or help me start one.
Give me the exact local page URL.

```

--------------------------------

### Update deploy_review script for server setup

Source: https://handbook.gitlab.com/handbook/customer-experience/professional-services-engineering/education-services/ilt-labs/advgitlabcicdhandsonlab3

Commands to prepare the remote server, install dependencies, and start the application via PM2.

```bash

  script:
    - ssh-keyscan -t rsa,ed25519 $ip >> ~/.ssh/known_hosts
    - ssh root@$ip 'mkdir -p /www'
    - ssh root@$ip 'sudo apt-get update'
    - ssh root@$ip 'sudo apt-get install nodejs npm -y'
    - ssh root@$ip 'cd /www/ && npm init -y'
    - ssh root@$ip 'cd /www/ && npm i express'
    - ssh root@$ip 'cd /www/ && npm i -g pm2'
    - scp index.js root@$ip:/www
    - ssh root@$ip 'pm2 start -f /www/index.js'

```

--------------------------------

### Start local preview with make view

Source: https://handbook.gitlab.com/docs/development/running-locally

Run from the repository folder to install npm dependencies, make theme tools available, sync data, and start the preview server. The first build can take several minutes; wait for Hugo to report the server is available, then open http://localhost:1313/.

```bash
make view

```

--------------------------------

### Plugin implementation of Init, Suspend, and Resume

Source: https://handbook.gitlab.com/handbook/engineering/architecture/design-documents/runner_suspendable_environments/fleeting

Shows how a plugin opts in by populating `ProviderInfo.Capabilities` in `Init()` and implementing `Suspend`/`Resume`. The comments outline the steps for each method.

```go
func (g *InstanceGroup) Init(ctx context.Context, log hclog.Logger, settings provider.Settings) (provider.ProviderInfo, error) {
    // existing init logic...
    return provider.ProviderInfo{
        // existing fields...
        Capabilities: []provider.Capability{provider.CapabilitySuspendResume},
    }, nil
}

func (g *InstanceGroup) Suspend(ctx context.Context, instances []string) ([]string, error) {
    // 1. Move instances out of auto-scaling management
    // 2. Stop instances
    // 3. Return IDs of successfully suspended instances
    return succeeded, nil
}

func (g *InstanceGroup) Resume(ctx context.Context, instances []string) ([]string, error) {
    // 1. Start instances
    // 2. Re-add instances to auto-scaling management
    // 3. Return IDs of successfully resumed instances
    return succeeded, nil
}
```

--------------------------------

### Install Homebrew using setup script

Source: https://handbook.gitlab.com/handbook/eta/css/resources/recommended-setup

Use this command on macOS to install Homebrew via their official setup script.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
Tokens:
Raw