Skip to content

Commit 2eb385d

Browse files
authored
fix: fix mkdocs site generation. update CHANGELOG/VERSION (argoproj#1321)
Signed-off-by: Jesse Suen <[email protected]>
1 parent 699ca23 commit 2eb385d

File tree

5 files changed

+52
-32
lines changed

5 files changed

+52
-32
lines changed

CHANGELOG.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,37 @@
11
# Changelog
22

3+
# v1.0.2
4+
5+
## Changes since v1.0.1
6+
7+
### Controller
8+
9+
* feat: allow VirtualService HTTPRoute to be inferred if there is single route (#1273)
10+
* fix: rollout paused longer than progressDeadlineSeconds would briefly degrade (#1268)
11+
* fix: controller would drop fields when updating DestinationRules (#1253)
12+
* fix: the wrong panel title on the sample dashboard (#1260)
13+
* fix: analysis with multiple metrics (#1261)
14+
* fix: Mitigate the bug where items are re-added constantly to the workqueue. #1193 (#1243)
15+
* fix: workload rollout spec is invalid template is not empty (#1224)
16+
* fix: Fix error check in validation for AnalysisTemplates not found (#1249)
17+
* fix: make function call consistent with otherRSs definition (#1171)
18+
19+
### Plugin
20+
21+
* fix: avoid using root user in plugin container (#1256)
22+
23+
24+
# v1.0.1
25+
26+
## Changes since v1.0.0
27+
28+
### Controller
29+
30+
* feat: WebMetric to support string body responses (#1212)
31+
* fix: Modify validation to check Analysis args passed through RO spec (#1215)
32+
* fix: AnalysisRun args could not be resolved from secret (#1213)
33+
34+
335
# v1.0.0
436

537
## Notable Features

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.0.0
1+
1.1.0

docs/features/notifications.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ by the end users. The end-users can subscribe to the configured triggers by addi
1212
The trigger defines the condition when the notification should be sent as well as the notification content template.
1313
Default Argo Rollouts comes with a list of built-in triggers that cover the most important events of Argo Rollout live-cycle.
1414
Both triggers and templates are configured in the `argo-rollouts-notification-configmap` ConfigMap. In order to get
15-
started quickly, you can use pre-configured notification templates defined in [notifications-install.yaml](../../manifests/notifications-install.yaml).
15+
started quickly, you can use pre-configured notification templates defined in [notifications-install.yaml](https://github.com/argoproj/argo-rollouts/blob/master/manifests/notifications-install.yaml).
1616

17-
If you are leveraging Kustomize it is recommended to include [notifications-install.yaml](../../manifests/notifications-install.yaml) as a remote
17+
If you are leveraging Kustomize it is recommended to include [notifications-install.yaml](https://github.com/argoproj/argo-rollouts/blob/master/manifests/notifications-install.yaml) as a remote
1818
resource into your `kustomization.yaml` file:
1919

2020
```yaml

hack/gen-docs/main.go

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ import (
1212
"strings"
1313

1414
"github.com/argoproj/notifications-engine/pkg/docs"
15-
1615
"github.com/spf13/cobra"
1716
"gopkg.in/yaml.v2"
17+
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
1818

1919
"github.com/argoproj/argo-rollouts/pkg/kubectl-argo-rollouts/cmd"
2020
options "github.com/argoproj/argo-rollouts/pkg/kubectl-argo-rollouts/options/fake"
@@ -63,11 +63,12 @@ func updateMkDocsNav(parent string, child string, files []string) error {
6363
if err != nil {
6464
return err
6565
}
66-
var mkdocs mkDocs
67-
if e := yaml.Unmarshal(data, &mkdocs); e != nil {
66+
var un unstructured.Unstructured
67+
if e := yaml.Unmarshal(data, &un.Object); e != nil {
6868
return e
6969
}
70-
navitem, _ := findNavItem(mkdocs.Nav, parent)
70+
nav := un.Object["nav"].([]interface{})
71+
navitem, _ := findNavItem(nav, parent)
7172
if navitem == nil {
7273
return fmt.Errorf("Can't find '%s' nav item in mkdoc.yml", parent)
7374
}
@@ -78,7 +79,7 @@ func updateMkDocsNav(parent string, child string, files []string) error {
7879
commands[child] = files
7980
navitemmap[parent] = append(subnav, commands)
8081

81-
newmkdocs, err := yaml.Marshal(mkdocs)
82+
newmkdocs, err := yaml.Marshal(un.Object)
8283
if err != nil {
8384
return err
8485
}
@@ -262,15 +263,3 @@ type byName []*cobra.Command
262263
func (s byName) Len() int { return len(s) }
263264
func (s byName) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
264265
func (s byName) Less(i, j int) bool { return s[i].Name() < s[j].Name() }
265-
266-
// mkDocs config struct to keep output order
267-
type mkDocs struct {
268-
SiteName string `yaml:"site_name,omitempty"`
269-
RepoURL string `yaml:"repo_url,omitempty"`
270-
Strict bool `yaml:"strict,omitempty"`
271-
Theme map[string]interface{} `yaml:"theme,omitempty"`
272-
GoogleAnalytics []string `yaml:"google_analytics,omitempty"`
273-
MarkdownExtensions []interface{} `yaml:"markdown_extensions,omitempty"`
274-
Plugins []interface{} `yaml:"plugins,omitempty"`
275-
Nav []interface{} `yaml:"nav,omitempty"`
276-
}

mkdocs.yml

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,3 @@
1-
site_name: Argo Rollouts - Kubernetes Progressive Delivery Controller
2-
repo_url: https://github.com/argoproj/argo-rollouts
3-
theme:
4-
font:
5-
text: Work Sans
6-
logo: assets/logo.png
7-
name: material
8-
palette:
9-
primary: teal
10-
google_analytics:
11-
- UA-105170809-3
12-
- auto
131
markdown_extensions:
142
- codehilite
153
- admonition
@@ -118,6 +106,17 @@ nav:
118106
- Contributing:
119107
- Contribution Guide: CONTRIBUTING.md
120108
- Environment Setup: getting-started/setup/index.md
109+
- Releasing: releasing.md
121110
- Releases ⧉: https://github.com/argoproj/argo-rollouts/releases
122111
- Roadmap ⧉: https://github.com/argoproj/argo-rollouts/milestones
123112
- Blog ⧉: https://blog.argoproj.io/
113+
repo_url: https://github.com/argoproj/argo-rollouts
114+
site_name: Argo Rollouts - Kubernetes Progressive Delivery Controller
115+
site_url: https://argoproj.github.io/argo-rollouts
116+
theme:
117+
font:
118+
text: Work Sans
119+
logo: assets/logo.png
120+
name: material
121+
palette:
122+
primary: teal

0 commit comments

Comments
 (0)