replicatedhq/ship

Config Options of type "label" should not be written to state.json

Open

#906 opened on Apr 10, 2019

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Go (68 forks)auto 404
good first issuetype::bug

Repository metrics

Stars
 (635 stars)
PR merge metrics
 (PR metrics pending)

Description

Expected behavior

With this config item:

      - name: https_label
        when: '{{repl ConfigOptionEquals "enable_ssl" "1" }}'
        title: Requests will be encrypted. HTTP requests will be redirected to HTTPS.
        type: label

is used, it should not have any effect on state.json, as its merely around presentation logic.

Actual behavior

The following is added to state.json#config.v1

      "https_label": "",

Information

  • Ship version: 0.39.0

Steps to reproduce

Use the following ship.yaml

assets:
  v1: []

config: 
  v1:
    - name: group
      items: 
      - name: https_label
        when: '{{repl ConfigOptionEquals "enable_ssl" "1" }}'
        title: Requests will be encrypted. HTTP requests will be redirected to HTTPS.
        type: label

lifecycle:
  v1:
     - config: {}
     - render: {}

and then

ship init path/to/yaml

then inspect state.json

cat .ship/state.json

Contributor guide

Research direction
Investigate how config items of type 'label' are serialized to state.json and ensure they are excluded during the config save process.
Tech stack
go
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60