Skip to content

Commit

Permalink
chore(nodejs): add stable/preview to release quality badge (#1313)
Browse files Browse the repository at this point in the history
  • Loading branch information
parthea committed Dec 30, 2021
1 parent 8d2c953 commit ecd89bd
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 5 deletions.
3 changes: 2 additions & 1 deletion synthtool/gcp/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,8 @@ def _load_repo_metadata(metadata_file: str = "./.repo-metadata.json") -> Dict:
* `product_documentation` - The product documentation on cloud.google.com
* `client_documentation` - The client library reference documentation
* `issue_tracker` - The public issue tracker for the product
* `release_level` - The release level of the client library. One of: alpha, beta, ga, deprecated
* `release_level` - The release level of the client library. One of: alpha, beta,
ga, deprecated, preview, stable
* `language` - The repo language. One of dotnet, go, java, nodejs, php, python, ruby
* `repo` - The GitHub repo in the format {owner}/{repo}
* `distribution_name` - The language-idiomatic package/distribution name
Expand Down
6 changes: 5 additions & 1 deletion synthtool/sources/templates.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,10 @@ def release_quality_badge(input: str) -> str:

if release_quality == "GA":
badge = "general%20availability%20%28GA%29-brightgreen"
elif release_quality == "STABLE":
badge = "general%20availability%20%28GA%29-brightgreen"
elif release_quality == "PREVIEW":
badge = "beta-yellow"
elif release_quality == "BETA":
badge = "beta-yellow"
elif release_quality == "ALPHA":
Expand All @@ -108,7 +112,7 @@ def release_quality_badge(input: str) -> str:
badge = "deprecated-red"
else:
log.error(
"Expected 'release_quality' to be one of: (ga, beta, alpha, eap, deprecated)"
"Expected 'release_quality' to be one of: (ga, stable, preview, beta, alpha, eap, deprecated)"
)
return ""
return f"[![release level](https://img.shields.io/badge/release%20level-{badge}.svg?style=flat)](https://cloud.google.com/terms/launch-stages)"
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/nodejs-dlp-with-staging/.repo-metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"client_documentation": "https://googleapis.dev/nodejs/dlp/latest",
"api_id": "dlp.googleapis.com",
"distribution_name": "@google-cloud/dlp",
"release_level": "ga",
"release_level": "stable",
"default_version": "v2",
"language": "nodejs",
"name_pretty": "Cloud Data Loss Prevention",
Expand Down
4 changes: 2 additions & 2 deletions tests/test_templates.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,10 @@ def test_render_preserve_mode():
def test_release_quality_badge():
t = templates.Templates(NODE_TEMPLATES)
result = t.render(
"README.md", metadata={"repo": {"release_level": "beta"}, "samples": {}}
"README.md", metadata={"repo": {"release_level": "preview"}, "samples": {}}
).read_text()
assert "https://img.shields.io/badge/release%20level-beta-yellow.svg" in result
assert "This library is considered to be in **beta**" in result
assert "This library is considered to be in **preview**" in result


def test_syntax_highlighter():
Expand Down

0 comments on commit ecd89bd

Please sign in to comment.