[#143] Update README instructions with the latest project changes #152

xvanick1 · 2021-02-16T11:39:42Z

No description provided.

xstefank

Minor comments, good work.

xstefank · 2021-02-16T13:36:20Z

README.md

-# Tyr
-
-![Powered by OpenShift Online](https://www.openshift.com/images/logos/powered_by_openshift.png)
+# Tyr ![Powered by OpenShift Online](https://www.openshift.com/images/logos/powered_by_openshift.png)


Won't this be now part of the title? Leave it on a separate line please.

xstefank · 2021-02-16T13:40:24Z

README.md

+
+## Description 
+
+Tyr is a Pull request status check tool for maintaining clean and uniform PR format of your project based on a preset template.\


Suggested change

Tyr is a Pull request status check tool for maintaining clean and uniform PR format of your project based on a preset template.\

Tyr is a Pull request status check tool for maintaining a clean and uniform PR format of your project based on a preset template.\

@xvanick1 I am using suggestions just to show precisely what I want changed. You can include changes in your next push no need to use Commit suggestion actions here.

xstefank · 2021-02-16T13:58:09Z

README.md

-      `tyr.template.format.url`
-1. start Tyr - `java -jar tyr-runner.jar` with above MP config properties set 
-   (as for instance system properties, e.g. `-Dtyr.template.format.file=/path/to/file`)
+1. Build Tyr with Maven in `tyr/tyr-runner/` folder using command `mvn clean install`


no, the whole project needs to be built + there is no tyr-runner anymore.

xstefank · 2021-02-16T14:05:15Z

README.md

+        1. Tick repo:status
+        1. Generate token
+        1. Use it as a value of this property, so the Tyr will be able to communicate with GitHub.
+   2. Next one is `tyr.template.format.file`, alternatively `tyr.template.format.url` - Represents path to configuration file specifying desired format of the Pull request. Example can be found in `tyr-runner/src/main/resources/format-example.yaml`


Suggested change

2. Next one is `tyr.template.format.file`, alternatively `tyr.template.format.url` - Represents path to configuration file specifying desired format of the Pull request. Example can be found in `tyr-runner/src/main/resources/format-example.yaml`

2. Next one is `tyr.template.format.file`, alternatively `tyr.template.format.url` - Represents the path to configuration file specifying desired format of the Pull request. Example can be found in `tyr-runner/src/main/resources/format-example.yaml`

xstefank · 2021-02-16T14:05:59Z

README.md

+    > Both properties can be passed to Tyr as:\
+        a. application properties - set once in `tyr-runner/src/main/resources/application.properties`. Necessary to rebuild Tyr after every adjustment of the file.\
+        b. system properties - passed as a parameter when starting Tyr. e.g. `-Dtyr.template.format.file=/path/to/file` (preferred option)\
+        c. CDI injection right into the code. 


?? by default, there is also an option to pass MP config as Environment property but I have no idea what you mean by this.

Could you provide any suggestions? This was meant just as an information for the user how the MC properties can be set in case of insufficient experience with microprofile.

c. as environment property TYR_TEMPLATE_FORMAT_FILE=/path/to/file

xstefank · 2021-02-16T14:07:24Z

README.md

+        b. system properties - passed as a parameter when starting Tyr. e.g. `-Dtyr.template.format.file=/path/to/file` (preferred option)\
+        c. CDI injection right into the code. 
+1. start Tyr - `java -jar tyr-runner.jar` with above MP config properties set.\
+   (as for instance with system properties, e.g. `java -jar -Dtyr.template.format.file="/path/to/file"tyr.github.oauth.token="afegxh64hnxh4646..." tyr-runner.jar`)


all system properties must come before -jar and also the jar is now called tyr-webhook-runner.jar

xstefank · 2021-02-16T14:09:38Z

README.md

-    - Set *Let me select individual events* and check only *Pull requests* 
+    1. In you test-repo - go to Settings -> Webhooks -> Add webhook
+    1. Fill in Payload URL -> *your local exposed IP which is provided by 
+    ngrok + “__/pull-request__”* (e. g., http://f202cf7c.ngrok.io/pull-request)


what is the reason for underscores?

README.md

xvanick1 · 2021-02-16T15:00:21Z

Thanks, I'll look into it.

xstefank · 2021-02-22T09:39:04Z

README.md

+        a. application properties - set once in `tyr-core/src/main/resources/application.properties`. Necessary to rebuild Tyr after every adjustment of the file.\
+        b. system properties - passed as a parameter when starting Tyr. e.g. `-Dtyr.template.format.file=/path/to/file` (preferred option)\
+        c. as environment property TYR_TEMPLATE_FORMAT_FILE=/path/to/file
+1. start Tyr - `java -jar tyr-webhook-core.jar` with above MP config properties set.\


? where did you find tyr-webhook-core.jar? Please try to follow your instructions to verify that they are working :)

xstefank · 2021-02-22T09:39:50Z

README.md

+        b. system properties - passed as a parameter when starting Tyr. e.g. `-Dtyr.template.format.file=/path/to/file` (preferred option)\
+        c. as environment property TYR_TEMPLATE_FORMAT_FILE=/path/to/file
+1. start Tyr - `java -jar tyr-webhook-core.jar` with above MP config properties set.\
+   (as for instance with system properties, e.g. `java -Dtyr.template.format.file="/path/to/file"tyr.github.oauth.token="afegxh64hnxh4646..."  -jar tyr-webhook-core.jar`)


again, try to run this command and you'll see that you need to specify each system property with separate -D

xstefank · 2021-02-22T09:40:34Z

README.md

-    - Set *Let me select individual events* and check only *Pull requests* 
+    1. In you test-repo - go to Settings -> Webhooks -> Add webhook
+    1. Fill in Payload URL -> *your local exposed IP which is provided by 
+    ngrok + **“/pull-request”*** (e. g., http://f202cf7c.ngrok.io/pull-request)


Suggested change

ngrok + **“/pull-request”*** (e. g., http://f202cf7c.ngrok.io/pull-request)

ngrok + **“/pull-request”*** (e.g., http://f202cf7c.ngrok.io/pull-request)

README.md

xstefank · 2021-02-22T16:01:32Z

README.md

+        b. system properties - passed as a parameter when starting Tyr. e.g. `-Dtyr.template.format.file=/path/to/file` (preferred option)\
+        c. as environment property TYR_TEMPLATE_FORMAT_FILE=/path/to/file
+1. start Tyr - `java -jar tyr-webhook-runner.jar` with above MP config properties set.\
+   (as for instance with system properties, e.g. `java -Dtyr.template.format.file="/path/to/file"t -Dyr.github.oauth.token="afegxh64hnxh4646..."  -jar tyr-webhook-runner.jar`)


Suggested change

(as for instance with system properties, e.g. `java -Dtyr.template.format.file="/path/to/file"t -Dyr.github.oauth.token="afegxh64hnxh4646..." -jar tyr-webhook-runner.jar`)

(as for instance with system properties, e.g. `java -Dtyr.template.format.file="/path/to/file" -Dtyr.github.oauth.token="afegxh64hnxh4646..." -jar tyr-webhook-runner.jar`)

lukasburda

Looks really good.. Can you provide information i request? Or you think it is described enough?

lukasburda · 2021-02-22T21:40:08Z

README.md

+    1. Edit value of the variable `repository` so it points to __your__ test-repo.
+    1. Edit value of the variable `statusUrl` so it points to __your__ test-repo or leave it default.
+    1. Now you have to set if you want Tyr to use any CI. 
+       * If NO, remove variable `CI` and all of it's content.


Command regexes could be removed also..

Currently readme file describes only required steps to successfully set up Tyr for first run and having those command regexes in there does not affect the first successful set up and run. I think that what you are suggesting would be better to have described in format-template.yaml file as a set of comments to let user know what does he have available in Tyr and how to set or disable individual options because it is up to user to specify what he wants to have available - how he configures the file. I admit that having the "statusUrl" on default does not affect the first successful run, but it is required to remove whole CI section from the file or set it correctly.

lukasburda · 2021-02-22T21:41:50Z

README.md

+    1. Edit value of the variable `statusUrl` so it points to __your__ test-repo or leave it default.
+    1. Now you have to set if you want Tyr to use any CI. 
+       * If NO, remove variable `CI` and all of it's content.
+       * If YES, set CI name, and it's properties. We are using TeamCity CI which properties are defined in the `TeamCityProperties` interface.


tyr.whitelist.enabled=true should be specified for allowing whitelisting and triggering CI

Update README.md based on PR jboss#143 review Update README.md based on 2nd review of PR jboss#143

xstefank · 2021-02-24T10:54:59Z

Thanks @xvanick1

xstefank requested changes Feb 16, 2021

View reviewed changes

xstefank requested changes Feb 22, 2021

View reviewed changes

xvanick1 force-pushed the update-readme branch 2 times, most recently from 4f91500 to c5de282 Compare February 22, 2021 15:31

xstefank requested changes Feb 22, 2021

View reviewed changes

xvanick1 force-pushed the update-readme branch from c5de282 to 562a5e3 Compare February 22, 2021 16:20

lukasburda suggested changes Feb 22, 2021

View reviewed changes

Update of README.md to reflect changes in Tyr develpment process.

4440eac

Update README.md based on PR jboss#143 review Update README.md based on 2nd review of PR jboss#143

xvanick1 force-pushed the update-readme branch from 562a5e3 to 4440eac Compare February 24, 2021 10:44

xstefank approved these changes Feb 24, 2021

View reviewed changes

xstefank merged commit c830e4c into jboss:master Feb 24, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#143] Update README instructions with the latest project changes #152

[#143] Update README instructions with the latest project changes #152

xvanick1 commented Feb 16, 2021

xstefank left a comment

xstefank Feb 16, 2021

xstefank Feb 16, 2021

xstefank Feb 16, 2021

xstefank Feb 16, 2021

xstefank Feb 16, 2021

xstefank Feb 16, 2021

xvanick1 Feb 18, 2021 •

edited

Loading

xstefank Feb 19, 2021 •

edited

Loading

xstefank Feb 16, 2021

xstefank Feb 16, 2021

xvanick1 commented Feb 16, 2021

xstefank Feb 22, 2021

xstefank Feb 22, 2021

xstefank Feb 22, 2021

xstefank Feb 22, 2021

lukasburda left a comment

lukasburda Feb 22, 2021

xvanick1 Feb 24, 2021 •

edited

Loading

lukasburda Feb 22, 2021

xstefank commented Feb 24, 2021


		## Description

		Tyr is a Pull request status check tool for maintaining clean and uniform PR format of your project based on a preset template.\

	2. Next one is `tyr.template.format.file`, alternatively `tyr.template.format.url` - Represents path to configuration file specifying desired format of the Pull request. Example can be found in `tyr-runner/src/main/resources/format-example.yaml`
	2. Next one is `tyr.template.format.file`, alternatively `tyr.template.format.url` - Represents the path to configuration file specifying desired format of the Pull request. Example can be found in `tyr-runner/src/main/resources/format-example.yaml`

	ngrok + “/pull-request”* (e. g., http://f202cf7c.ngrok.io/pull-request)
	ngrok + “/pull-request”* (e.g., http://f202cf7c.ngrok.io/pull-request)

	(as for instance with system properties, e.g. `java -Dtyr.template.format.file="/path/to/file"t -Dyr.github.oauth.token="afegxh64hnxh4646..." -jar tyr-webhook-runner.jar`)
	(as for instance with system properties, e.g. `java -Dtyr.template.format.file="/path/to/file" -Dtyr.github.oauth.token="afegxh64hnxh4646..." -jar tyr-webhook-runner.jar`)

[#143] Update README instructions with the latest project changes #152

[#143] Update README instructions with the latest project changes #152

Conversation

xvanick1 commented Feb 16, 2021

xstefank left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xvanick1 Feb 18, 2021 • edited Loading

Choose a reason for hiding this comment

xstefank Feb 19, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xvanick1 commented Feb 16, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lukasburda left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xvanick1 Feb 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xstefank commented Feb 24, 2021

xvanick1 Feb 18, 2021 •

edited

Loading

xstefank Feb 19, 2021 •

edited

Loading

xvanick1 Feb 24, 2021 •

edited

Loading