Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: mkdocs site generation. update CHANGELOG/VERSION #1321

Merged
merged 1 commit into from
Jul 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,37 @@
# Changelog

# v1.0.2

## Changes since v1.0.1

### Controller

* feat: allow VirtualService HTTPRoute to be inferred if there is single route (#1273)
* fix: rollout paused longer than progressDeadlineSeconds would briefly degrade (#1268)
* fix: controller would drop fields when updating DestinationRules (#1253)
* fix: the wrong panel title on the sample dashboard (#1260)
* fix: analysis with multiple metrics (#1261)
* fix: Mitigate the bug where items are re-added constantly to the workqueue. #1193 (#1243)
* fix: workload rollout spec is invalid template is not empty (#1224)
* fix: Fix error check in validation for AnalysisTemplates not found (#1249)
* fix: make function call consistent with otherRSs definition (#1171)

### Plugin

* fix: avoid using root user in plugin container (#1256)


# v1.0.1

## Changes since v1.0.0

### Controller

* feat: WebMetric to support string body responses (#1212)
* fix: Modify validation to check Analysis args passed through RO spec (#1215)
* fix: AnalysisRun args could not be resolved from secret (#1213)


# v1.0.0

## Notable Features
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ release-docs: docs

# convenience target to run `mkdocs serve` using a docker container
.PHONY: serve-docs
serve-docs: plugin-docs
serve-docs: docs
docker run --rm -it -p 8000:8000 -v ${CURRENT_DIR}:/docs squidfunk/mkdocs-material serve -a 0.0.0.0:8000

.PHONY: release-precheck
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.0.0
1.1.0
4 changes: 2 additions & 2 deletions docs/features/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ by the end users. The end-users can subscribe to the configured triggers by addi
The trigger defines the condition when the notification should be sent as well as the notification content template.
Default Argo Rollouts comes with a list of built-in triggers that cover the most important events of Argo Rollout live-cycle.
Both triggers and templates are configured in the `argo-rollouts-notification-configmap` ConfigMap. In order to get
started quickly, you can use pre-configured notification templates defined in [notifications-install.yaml](../../manifests/notifications-install.yaml).
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).

If you are leveraging Kustomize it is recommended to include [notifications-install.yaml](../../manifests/notifications-install.yaml) as a remote
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
resource into your `kustomization.yaml` file:

```yaml
Expand Down
23 changes: 6 additions & 17 deletions hack/gen-docs/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ import (
"strings"

"github.com/argoproj/notifications-engine/pkg/docs"

"github.com/spf13/cobra"
"gopkg.in/yaml.v2"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"

"github.com/argoproj/argo-rollouts/pkg/kubectl-argo-rollouts/cmd"
options "github.com/argoproj/argo-rollouts/pkg/kubectl-argo-rollouts/options/fake"
Expand Down Expand Up @@ -63,11 +63,12 @@ func updateMkDocsNav(parent string, child string, files []string) error {
if err != nil {
return err
}
var mkdocs mkDocs
if e := yaml.Unmarshal(data, &mkdocs); e != nil {
var un unstructured.Unstructured
if e := yaml.Unmarshal(data, &un.Object); e != nil {
return e
}
navitem, _ := findNavItem(mkdocs.Nav, parent)
nav := un.Object["nav"].([]interface{})
navitem, _ := findNavItem(nav, parent)
if navitem == nil {
return fmt.Errorf("Can't find '%s' nav item in mkdoc.yml", parent)
}
Expand All @@ -78,7 +79,7 @@ func updateMkDocsNav(parent string, child string, files []string) error {
commands[child] = files
navitemmap[parent] = append(subnav, commands)

newmkdocs, err := yaml.Marshal(mkdocs)
newmkdocs, err := yaml.Marshal(un.Object)
if err != nil {
return err
}
Expand Down Expand Up @@ -262,15 +263,3 @@ type byName []*cobra.Command
func (s byName) Len() int { return len(s) }
func (s byName) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
func (s byName) Less(i, j int) bool { return s[i].Name() < s[j].Name() }

// mkDocs config struct to keep output order
type mkDocs struct {
SiteName string `yaml:"site_name,omitempty"`
RepoURL string `yaml:"repo_url,omitempty"`
Strict bool `yaml:"strict,omitempty"`
Theme map[string]interface{} `yaml:"theme,omitempty"`
GoogleAnalytics []string `yaml:"google_analytics,omitempty"`
MarkdownExtensions []interface{} `yaml:"markdown_extensions,omitempty"`
Plugins []interface{} `yaml:"plugins,omitempty"`
Nav []interface{} `yaml:"nav,omitempty"`
}
23 changes: 11 additions & 12 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,3 @@
site_name: Argo Rollouts - Kubernetes Progressive Delivery Controller
repo_url: https://github.com/argoproj/argo-rollouts
theme:
font:
text: Work Sans
logo: assets/logo.png
name: material
palette:
primary: teal
google_analytics:
- UA-105170809-3
- auto
markdown_extensions:
- codehilite
- admonition
Expand Down Expand Up @@ -118,6 +106,17 @@ nav:
- Contributing:
- Contribution Guide: CONTRIBUTING.md
- Environment Setup: getting-started/setup/index.md
- Releasing: releasing.md
- Releases ⧉: https://github.com/argoproj/argo-rollouts/releases
- Roadmap ⧉: https://github.com/argoproj/argo-rollouts/milestones
- Blog ⧉: https://blog.argoproj.io/
repo_url: https://github.com/argoproj/argo-rollouts
site_name: Argo Rollouts - Kubernetes Progressive Delivery Controller
site_url: https://argoproj.github.io/argo-rollouts
theme:
font:
text: Work Sans
logo: assets/logo.png
name: material
palette:
primary: teal