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

docs: add a link to the changelog file from the main readme #1067

Closed
wants to merge 2 commits into from

Conversation

feywind
Copy link
Collaborator

@feywind feywind commented Jul 21, 2020

This adds an explicit link to the most recent version of the CHANGELOG file, to make it easier to see what's changed.

Synthtool should regenerate this file fully on its next run, but I wanted to go ahead and push out a regenerated version of that one file.

Quick fix for #1007

@feywind feywind requested review from a team as code owners July 21, 2020 22:45
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Jul 21, 2020
@codecov
Copy link

codecov bot commented Jul 22, 2020

Codecov Report

Merging #1067 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1067   +/-   ##
=======================================
  Coverage   95.09%   95.09%           
=======================================
  Files          24       24           
  Lines       10887    10887           
  Branches      498      517   +19     
=======================================
  Hits        10353    10353           
  Misses        531      531           
  Partials        3        3           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4b7f4a0...004a2f8. Read the comment docs.

@@ -8,6 +8,9 @@ introduction: |-
[Pub/Sub quickstart](https://cloud.google.com/pubsub/docs/quickstart-client-libraries),
[publisher](https://cloud.google.com/pubsub/docs/publisher), and [subscriber](https://cloud.google.com/pubsub/docs/subscriber)
guides.

A fairly comprehensive list of changes in each version may be found in
Copy link
Contributor

Choose a reason for hiding this comment

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

It feels like this would have generalized value linked from the README. What do you think of adding a section to the README in synthtool so everyone in the class gets this?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I wasn't sure if it should get templated into synthtool or not. I can do a PR for that if it seems like something everyone would want to have.

@feywind
Copy link
Collaborator Author

feywind commented Jul 30, 2020

This was made obsolete by this pull request on synthtool:

googleapis/synthtool#701

That should propagate over on the next library generation.

@feywind feywind closed this Jul 30, 2020
@feywind feywind deleted the gh1007-changelog-link branch July 30, 2020 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants