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

Refactor dynamicconfig comments for documentation #4129

Merged
merged 5 commits into from
Apr 14, 2021

Conversation

longquanzheng
Copy link
Collaborator

@longquanzheng longquanzheng commented Apr 11, 2021

What changed?
Refactor dynamicconfig comments

Why?
To introduce a better way to manage/maintain the documentation of dynamic configuration for the community

Currently it requires developer to go to cadence-docs to update the configuration.
This is tedious and inconvenient for our developers. Moreover, there is no easy way to know what configurations is available in which release versions.

A better way is just update in the comments, and go-docs will automatically update the document with the right release version. See example: https://pkg.go.dev/github.com/uber/cadence@v0.19.1/common/service/dynamicconfig#Key

How did you test it?
Existing

Potential risks
No. only comment change.

Release notes

Documentation Changes
Will update cadence-docs to use go-docs after this is released.
uber/Cadence-Docs#33

@coveralls
Copy link

coveralls commented Apr 11, 2021

Pull Request Test Coverage Report for Build b16c962b-5a58-4bb7-8a52-10fe76ab274f

  • 35 of 45 (77.78%) changed or added relevant lines in 1 file are covered.
  • 42 unchanged lines in 5 files lost coverage.
  • Overall coverage increased (+0.04%) to 67.912%

Changes Missing Coverage Covered Lines Changed/Added Lines %
common/dynamicconfig/filter.go 35 45 77.78%
Files with Coverage Reduction New Missed Lines %
service/history/execution/mutable_state_task_refresher.go 1 75.29%
common/task/weightedRoundRobinTaskScheduler.go 2 89.12%
common/persistence/cassandra/cassandraPersistence.go 3 52.8%
common/task/fifoTaskScheduler.go 3 84.54%
common/persistence/cassandra/cassandraPersistenceUtil.go 33 90.42%
Totals Coverage Status
Change from base Build 0e13b30a-1b53-4579-8cdc-f819ac5503ad: 0.04%
Covered Lines: 98784
Relevant Lines: 145459

💛 - Coveralls

Copy link
Contributor

@yycptt yycptt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 👍 👍

common/dynamicconfig/constants.go Show resolved Hide resolved
fix

done

address comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants