Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

#15 update README.md and action.yml #16

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

Merged
shenxianpeng merged 4 commits into master from release/1.2.0
Aug 22, 2021
Merged

#15 update README.md and action.yml #16

shenxianpeng merged 4 commits into master from release/1.2.0
Aug 22, 2021

Conversation

@shenxianpeng
Copy link
Collaborator

@shenxianpeng shenxianpeng commented Aug 22, 2021

Update README.md and add result.png to demo folder.

Copy link
Collaborator Author

Before you make a new release it may be prudent to delete any previously posted comments (made by the bot) when posting new comments to the same thread.

Sorry, I don't get your point, can you explain more?
I'm not an English native speaker, could you help to review and modify if need?
Thank you.

Copy link
Collaborator

2bndy5 commented Aug 22, 2021

Imagine a PR is opened and the source file(s) invoke a bot comment from this action. Any successive commits to the same PR will only add more bot comments to that PR not replace or remove any outdated bot comments.

There is a way to update a comment via the REST API.

Copy link
Collaborator

2bndy5 commented Aug 22, 2021

I think the repo's description should be updated also. This is to make it stick out less like a duplicate and more like an improved fork
image
vs the older
image

This can be only done by you in the repo's sidebar's settings
image

shenxianpeng reacted with thumbs up emoji

Copy link
Collaborator Author

👍 I will update in one hour when I back from lunch/dinner.

Copy link
Collaborator Author

Or change the repo's description to "GitHub Action for Linting C/C++ code as part of your workflows!". your thoughts?

Copy link
Collaborator Author

I think after this release, the name of this GitHub app should be changed to "C/C++ Lint Action"

Copy link
Collaborator

2bndy5 commented Aug 22, 2021
edited
Loading

Best to use the words (in the description)

  • "improved" (or something similar - maybe "evolved")
  • "push" (non-negotiable)
  • "pull_request" (maybe implied but could be informative)
  • you're on the right track with "workflows"

I think the name (if changed) would need to be done prior to release. See the GH docs about action.yml metadata. IMHO, I like the idea of renaming the action also (I also like your suggested idea).

Copy link
Collaborator Author

shenxianpeng commented Aug 22, 2021
edited
Loading

"IMPROVED C/C++ Lint Action: Automatically checks pull/pull_request changes with clang-tidy, clang-format, and posts the comment with result.", like this?

Copy link
Collaborator

2bndy5 commented Aug 22, 2021

How do you like this?

Improved C/C++ Lint Action: Automatically checks push & pull request changes with clang-tidy & clang-format, then posts a comment with faulty results

shenxianpeng reacted with thumbs up emoji shenxianpeng reacted with heart emoji

@shenxianpeng shenxianpeng changed the title (削除) #15 update README.md and add result.png (削除ここまで) (追記) #15 update README.md and action.yml (追記ここまで) Aug 22, 2021
Copy link
Collaborator Author

Imagine a PR is opened and the source file(s) invoke a bot comment from this action. Any successive commits to the same PR >will only add more bot comments to that PR not replace or remove any outdated bot comments.

There is a way to update a comment via the REST API.

Yes, this is a problem. but if only has opened type event of pull_request, new commits include new source file(s) changes will not have bot comments. does REST API can deal with this

Copy link
Collaborator

2bndy5 commented Aug 22, 2021

That only avoids duplicate triggered runs for 1 commit. I want to avoid a scenario like what I see in one of my testing PRs Notice the multiple comments made.

Copy link
Collaborator Author

Maybe we can create another ticket to track avoid duplicate comments issue rather than limit pull_request type to opened

For this version, I guess it's ready to release. assign to you for review.

@shenxianpeng shenxianpeng added release To track release notes and update documentation Improvements or additions to documentation labels Aug 22, 2021
Copy link
Collaborator

@2bndy5 2bndy5 left a comment

Choose a reason for hiding this comment

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

ok. I guess users will have to manage/edit/delete comments at their behest (for now).

I often forget that it is best to release often rather than release huge number of changes seldomly.

Copy link
Collaborator Author

It seems there is no way to see how many users are using this app. I guess very little.
This version is much better than before, and we should let them see it as soon as possible.

@shenxianpeng shenxianpeng merged commit 2f23e57 into master Aug 22, 2021
Copy link
Collaborator

2bndy5 commented Aug 22, 2021

Technically the marketplace's page for this action is up-to-date with the repo's master branch (despite if a release has happened or not).

Copy link
Collaborator Author

You're right. the release looks only affect the app's name and description.

2bndy5 reacted with thumbs up emoji

@shenxianpeng shenxianpeng deleted the release/1.2.0 branch August 22, 2021 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@2bndy5 2bndy5 2bndy5 approved these changes

Labels

documentation Improvements or additions to documentation release To track release notes and update

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /