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

feat: add option to skip ci run #213

Merged
merged 9 commits into from
Dec 17, 2021
Merged

feat: add option to skip ci run #213

merged 9 commits into from
Dec 17, 2021

Conversation

nenadfilipovic
Copy link
Contributor

PR summary:

  • Added feature to skip ci run
  • Added configuration to disable or enable prompt
  • Added chinese translation
  • Update documentation with prompt config

Fix: #212

@vivaxy please check if chinese translation is correct I have used google translate

Add feature to ask user should ci run be skipped.
@yi-Xu-0100 yi-Xu-0100 added the wait-to-build PR wait to build package. label Nov 29, 2021
@github-actions github-actions bot removed the wait-to-build PR wait to build package. label Nov 29, 2021
@github-actions
Copy link
Contributor

The beta extension of this pull has been built in the workflow! 🎉
Download vscode-conventional-commits-817b22d.vsix in artifacts. 🚀

@vivaxy
Copy link
Owner

vivaxy commented Nov 30, 2021

@nenadfilipovic Cool PR!
I think we should set promptCi as false by default to preserve current user experience.

BTW. skip ci feature can work in many ways. Ref: https://github.blog/changelog/2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci/. Should we provide configurations to:

  1. Set [skip ci] position. e.g. head or tail in header section.
  2. Set different keyword? e.g. [skip ci], [ci skip], e.t.c.

Set promptCi as false by default to preserve current user experience.
@nenadfilipovic
Copy link
Contributor Author

nenadfilipovic commented Dec 1, 2021

Ok I have changed it to be false by default.

To answer other 2 questions:

  1. I don't have strong opinion on where should [skip ci] be, I usually put it at the end of the header
  2. By looking here https://www.scivision.dev/skip-ci-builds-git-commit/ I came to conclusion that [skip ci] is universally accepted form by most git hosting services and I think we should use it

@vivaxy
Copy link
Owner

vivaxy commented Dec 2, 2021

@yi-Xu-0100 Any more questions?

@yi-Xu-0100
Copy link
Collaborator

yi-Xu-0100 commented Dec 2, 2021

👋 @nenadfilipovic, thanks for your great contribution! ❤ I think it is a clear way to prompt the condition about the skip CI. After reviewing the realization about the prompt, I have a little advice about the format of the prompt.

@vivaxy May we can make the prompt to have choices with two options? The first one is No, and it will add none character into the placeholder and will be the default choice. The second one is Yes, and it will replace the character of the placeholder with yes. The format will be like the emoji prompt, and it can be picked with the mouse easier. 🧐

For the above optional skip CI prompt, maybe it should prompt after choose the emoji.

@yi-Xu-0100 yi-Xu-0100 added the wait-to-build PR wait to build package. label Dec 2, 2021
@github-actions github-actions bot removed the wait-to-build PR wait to build package. label Dec 2, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Dec 2, 2021

The beta extension of this pull has been built in the workflow! 🎉
Download vscode-conventional-commits-6f66b3d.vsix in artifacts. 🚀

Use quick select prompt instead of input box.
Set promptCi as false by default to preserve current user experience.
@nenadfilipovic
Copy link
Contributor Author

nenadfilipovic commented Dec 2, 2021

Ok, latest changes:

  • Added CI prompt after emoji prompt
  • Replaced input box with quick pick box with Yes and No options
  • Formatted table inside readme file

Format markdown table inside readme with http://markdowntable.com/.
Update promptCi documentation that reflects that prompt is disabled by default.
@yi-Xu-0100 yi-Xu-0100 added the wait-to-build PR wait to build package. label Dec 3, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Dec 3, 2021

The beta extension of this pull has been built in the workflow! 🎉
Download vscode-conventional-commits-b9d9efc.vsix in artifacts. 🚀

@github-actions github-actions bot removed the wait-to-build PR wait to build package. label Dec 3, 2021
@nenadfilipovic
Copy link
Contributor Author

@vivaxy @yi-Xu-0100 do you think PR is good?

@yi-Xu-0100
Copy link
Collaborator

@vivaxy, I think a little discussion is needed here about my reviews. 🧐

I had made a beta extension for the current pr to be used temporarily if you require it- #213 (comment). 😁@nenadfilipovic

@vivaxy
Copy link
Owner

vivaxy commented Dec 10, 2021

Look Good To Me.

A trivial discussion:

For the above optional skip CI prompt, maybe it should prompt after choose the emoji.

Second thought, why is that? [skip ci] is appended after subject. Why is it not prompt after subject?

@yi-Xu-0100
Copy link
Collaborator

@vivaxy I think the selection can be simply completed by a mouse so that it should be prompt after emoji, and after that, it all will be keyboard things (even we can use enter and arrow keys to complete selection).

By the way, what is your opinion about the configuration variable naming and translation I suggested above?

package.nls.zh-cn.json Outdated Show resolved Hide resolved
package.nls.zh-cn.json Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@yi-Xu-0100
Copy link
Collaborator

@nenadfilipovic @vivaxy

I may misunderstand the GitHub UI review works, I have make reviews two days ago, but I did not successfully submit my review, I thought you all saw it. Sorry for the late work. 😅

@nenadfilipovic
Copy link
Contributor Author

I can't say anything about Chinese translation because I don't speak it. We can also use promptSkipCI no problem about that.

@vivaxy
Copy link
Owner

vivaxy commented Dec 11, 2021

Thanks @yi-Xu-0100 . It's a thoughtfully review.

@yi-Xu-0100
Copy link
Collaborator

@vivaxy I have pushed the changes to this PR. If there is no other problem, I will squash and merge this PR and publish it next Friday. 🧐

@nenadfilipovic Thanks for your great PR! ❤

@yi-Xu-0100 yi-Xu-0100 added the wait-to-build PR wait to build package. label Dec 11, 2021
@github-actions
Copy link
Contributor

The beta extension of this pull has been built in the workflow! 🎉
Download vscode-conventional-commits-ed660da.vsix in artifacts. 🚀

@github-actions github-actions bot removed the wait-to-build PR wait to build package. label Dec 11, 2021
@nenadfilipovic
Copy link
Contributor Author

Good job, very nice experience working with you @vivaxy @yi-Xu-0100 👋

@yi-Xu-0100 yi-Xu-0100 merged commit 67c9da7 into vivaxy:master Dec 17, 2021
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.

[FEAT] Add skip ci feature
3 participants