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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update existing PR comments example #178

Merged
merged 1 commit into from Apr 8, 2022

Conversation

tobiasbueschel
Copy link
Contributor

@tobiasbueschel tobiasbueschel commented Apr 6, 2022

Thanks for all your efforts with this github action 馃憦

This PR improves the example in the documentation by ensuring that the PR comment made is updated instead of creating a new comment. I realize that in some situations a new comment is desirable, however, this PR assumes that for most use cases updating an existing comment for a PR is desirable.

@hashicorp-cla
Copy link

@hashicorp-cla hashicorp-cla commented Apr 6, 2022

CLA assistant check
All committers have signed the CLA.

Copy link
Collaborator

@jpogran jpogran left a comment

Thank you @tobiasbueschel for the contribution! I do think this is a valuable example to add, but also think it is valuable to have the prior example in addition to this one.

Can you leave the current example as is, and make your example an entirely new one underneath this? This way we take the explanation you put in the PR description inside the README and users can see the different ways you can configure this action.

@jpogran jpogran added the documentation label Apr 7, 2022
@tobiasbueschel
Copy link
Contributor Author

@tobiasbueschel tobiasbueschel commented Apr 8, 2022

@jpogran absolutely, I've just updated the PR to reflect this :) Do let me know if there's anything else I should change. Thanks

@jpogran jpogran self-assigned this Apr 8, 2022
@jpogran jpogran added this to the 2.0.0 milestone Apr 8, 2022
jpogran
jpogran approved these changes Apr 8, 2022
@jpogran jpogran merged commit b11dc8a into hashicorp:main Apr 8, 2022
55 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants