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.

Sign up for GitHub

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(docs): use pymdownx.tilde extension to render deleted content #546

Merged
merged 1 commit into from
Nov 17, 2023
Merged

fix(docs): use pymdownx.tilde extension to render deleted content #546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## [MAJOR.MINOR.PATCH] - YYYY-MM-DD

## v0.15.0 - 2023-11-16
## v0.15.0 - 2023-11-17

- Upgrade to Go 1.21
- Add option to orphan resources. Thanks to @atarax
Expand All @@ -28,7 +28,7 @@
URL. By setting this the SASL SSL OAuth2/OIDC authentication is enabled
- Add `Kafka` field `userConfig.kafka.sasl_oauthbearer_sub_claim_name`, type `string`: Name of the scope
from which to extract the subject claim from the JWT. Defaults to sub
- Change `Kafka` field `userConfig.kafka_version`: enum ~`[3.1, 3.3, 3.4, 3.5]`~ → `[3.1, 3.3, 3.4,
- Change `Kafka` field `userConfig.kafka_version`: enum ~~`[3.1, 3.3, 3.4, 3.5]`~~ → `[3.1, 3.3, 3.4,
3.5, 3.6]`
- Change `Kafka` field `userConfig.tiered_storage.local_cache.size`: deprecated
- Add `OpenSearch` field `userConfig.opensearch.indices_memory_max_index_buffer_size`, type `integer`:
Expand All @@ -40,9 +40,9 @@
- Change `OpenSearch` field `userConfig.opensearch.auth_failure_listeners.internal_authentication_backend_limiting.type`:
enum `[username]`
- Change `OpenSearch` field `userConfig.opensearch.auth_failure_listeners.ip_rate_limiting.type`: enum `[ip]`
- Change `OpenSearch` field `userConfig.opensearch.search_max_buckets`: maximum ~`65536`~ → `1000000`
- Change `OpenSearch` field `userConfig.opensearch.search_max_buckets`: maximum ~~`65536`~~ → `1000000`
- Change `ServiceIntegration` field `kafkaMirrormaker.kafka_mirrormaker.producer_max_request_size`: maximum
~`67108864`~ → `268435456`
~~`67108864`~~ → `268435456`

## v0.14.0 - 2023-09-21

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

## v0.15.0 - 2023-11-16
## v0.15.0 - 2023-11-17

- Upgrade to Go 1.21
- Add option to orphan resources. Thanks to @atarax
Expand All @@ -26,7 +26,7 @@
URL. By setting this the SASL SSL OAuth2/OIDC authentication is enabled
- Add `Kafka` field `userConfig.kafka.sasl_oauthbearer_sub_claim_name`, type `string`: Name of the scope
from which to extract the subject claim from the JWT. Defaults to sub
- Change `Kafka` field `userConfig.kafka_version`: enum ~`[3.1, 3.3, 3.4, 3.5]`~ → `[3.1, 3.3, 3.4,
- Change `Kafka` field `userConfig.kafka_version`: enum ~~`[3.1, 3.3, 3.4, 3.5]`~~ → `[3.1, 3.3, 3.4,
3.5, 3.6]`
- Change `Kafka` field `userConfig.tiered_storage.local_cache.size`: deprecated
- Add `OpenSearch` field `userConfig.opensearch.indices_memory_max_index_buffer_size`, type `integer`:
Expand All @@ -38,9 +38,9 @@
- Change `OpenSearch` field `userConfig.opensearch.auth_failure_listeners.internal_authentication_backend_limiting.type`:
enum `[username]`
- Change `OpenSearch` field `userConfig.opensearch.auth_failure_listeners.ip_rate_limiting.type`: enum `[ip]`
- Change `OpenSearch` field `userConfig.opensearch.search_max_buckets`: maximum ~`65536`~ → `1000000`
- Change `OpenSearch` field `userConfig.opensearch.search_max_buckets`: maximum ~~`65536`~~ → `1000000`
- Change `ServiceIntegration` field `kafkaMirrormaker.kafka_mirrormaker.producer_max_request_size`: maximum
~`67108864`~ → `268435456`
~~`67108864`~~ → `268435456`

## v0.14.0 - 2023-09-21

Expand Down
3 changes: 2 additions & 1 deletion docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@ markdown_extensions:
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tilde
- pymdownx.details
- tables
- admonition
- pymdownx.details
- attr_list
- toc:
permalink: true
Expand Down
10 changes: 7 additions & 3 deletions generators/charts/changelog.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ func fmtChanges(was, has *schema) string {
return strings.Join(sortedKeys(changes), ", ")
}

// fmtChange returns a string like: foo ~`0`~ → `1` or empty string
// fmtChange returns a string like: foo ~~`0`~~ → `1` or empty string
func fmtChange[T any](title string, was, has *T) string {
if cmp.Equal(was, has) {
return ""
Expand All @@ -167,9 +167,9 @@ func fmtWasHas(sep, was, has string) string {
case was:
return has
case has:
return fmt.Sprintf("~%s~", was)
return fmt.Sprintf("~~%s~~", was)
}
return fmt.Sprintf("~%s~%s%s", was, sep, has)
return fmt.Sprintf("~~%s~~%s%s", was, sep, has)
}

func strSlice(src []any) string {
Expand Down Expand Up @@ -295,6 +295,10 @@ func updateChangelog(operatorPath, crdCharts string) (func() error, error) {
changes = append(changes, kindChanges...)
}

if len(changes) == 0 {
return nil
}

// Reads changelogFile
changelogPath := path.Join(operatorPath, changelogFile)
changelogBody, err := os.ReadFile(changelogPath)
Expand Down
4 changes: 2 additions & 2 deletions generators/charts/changelog_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ func TestGenChangelog(t *testing.T) {
require.NoError(t, err)

expect := []string{"Add `Kafka` field `disk_space`, type `string`: The disk space of the service",
"Change `Kafka` field `cloudName`: enum ~`[bar, foo]`~ → `[bar, baz, foo]`, maxLength ~`120`~ → `256`, maximum ~`2`~ → `4`, minimum ~`1`~ → `3`",
"Change `Kafka` field `topic_name`: enum `[bar, baz, foo]`, format ~`^[1-9]*(GiB|G)*`~ → `^[1-9][0-9]*(GiB|G)*`, maxLength ~`111`~ → `249`, maximum `1000000`, minLength `1`, minimum `1`",
"Change `Kafka` field `cloudName`: enum ~~`[bar, foo]`~~ → `[bar, baz, foo]`, maxLength ~~`120`~~ → `256`, maximum ~~`2`~~ → `4`, minimum ~~`1`~~ → `3`",
"Change `Kafka` field `topic_name`: enum `[bar, baz, foo]`, format ~~`^[1-9]*(GiB|G)*`~~ → `^[1-9][0-9]*(GiB|G)*`, maxLength ~~`111`~~ → `249`, maximum `1000000`, minLength `1`, minimum `1`",
"Remove `Kafka` field `karapace`, type `boolean`: Switch the service to use Karapace for schema registry and REST proxy",
}

Expand Down
Loading