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

[#1407] DG: add Gradle instructions to workflow #1408

Merged
merged 9 commits into from
Feb 3, 2021

Conversation

HCY123902
Copy link
Contributor

Resolves #1407

Commit message:

Add gradle instructions for check style and back end testing 
in workflow

The original workflow does not specifically mention the
gradle commands to be executed for style checking and back
end testing.

Adding this information can help new developers to get started
more quickly.

Let's add the relevant gradle instructions to the Developer 
Guide.

@HCY123902 HCY123902 requested a review from a team January 17, 2021 10:20
Copy link
Contributor

@Tejas2805 Tejas2805 left a comment

Choose a reason for hiding this comment

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

LGTM! One nit.

@@ -28,7 +28,7 @@ Our workflow is mostly based on the guidelines given at se-education.org/guides.
* Make sure you know our coding standards.
{{ embed('Appendix: Coding Standards', 'styleGuides.md', level=2) }}
* **Follow [this](https://se-education.org/guides/tutorials/intellijCodeStyle.html) to configure Intellij to follow our coding style**.
* **This project uses Checkstyle** to check the compliance of Java code. You can use [this document](https://se-education.org/guides/tutorials/checkstyle.html) to find how to use it.
* **This project uses Checkstyle** to check the compliance of Java code. You can use [this document](https://se-education.org/guides/tutorials/checkstyle.html) to find how to use it. In Particular, run `gradlew checkstyleMain checkstyleTest checkstyleSystemtest` to check the style of all the relevant Java code.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* **This project uses Checkstyle** to check the compliance of Java code. You can use [this document](https://se-education.org/guides/tutorials/checkstyle.html) to find how to use it. In Particular, run `gradlew checkstyleMain checkstyleTest checkstyleSystemtest` to check the style of all the relevant Java code.
* **This project uses Checkstyle** to check the compliance of Java code. You can use [this document](https://se-education.org/guides/tutorials/checkstyle.html) to find how to use it. In particular, run `gradlew checkstyleMain checkstyleTest checkstyleSystemtest` to check the style of all the relevant Java code.

Copy link
Contributor Author

@HCY123902 HCY123902 Jan 17, 2021

Choose a reason for hiding this comment

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

Thanks for pointing it out. I have edited it.

@HCY123902 HCY123902 requested a review from a team January 18, 2021 15:47
@fzdy1914 fzdy1914 changed the title [#1407] Add gradle instructions to workflow in Developer Guide [#1407] DG: add Gradle instructions to workflow Jan 19, 2021
@fzdy1914
Copy link
Member

@dcshzj Any idea why the deployment is failing here?

@dcshzj dcshzj closed this Jan 25, 2021
@dcshzj dcshzj reopened this Jan 25, 2021
@dcshzj
Copy link
Member

dcshzj commented Jan 25, 2021

@dcshzj Any idea why the deployment is failing here?

The deployment code itself works, but I think the issue was that there were multiple instances of it running. The surge.sh deployment cannot perfectly pinpoint the exact workflow run to download the artifacts for.

One way is to not trigger too many CI runs within a short time frame. If deployment fails again, we can just trigger it again by closing and reopening the PR.

@fzdy1914
Copy link
Member

@dcshzj Any idea why the deployment is failing here?

The deployment code itself works, but I think the issue was that there were multiple instances of it running. The surge.sh deployment cannot perfectly pinpoint the exact workflow run to download the artifacts for.

One way is to not trigger too many CI runs within a short time frame. If deployment fails again, we can just trigger it again by closing and reopening the PR.

Can you try to look into a fix for it? As it is affecting our normal usage.

Instead of uploading artifacts into one position. Is modifying the path or name helping, different repo have a different paths?
image

Just look into it first.

@fzdy1914
Copy link
Member

@dcshzj Any idea why the deployment is failing here?

The deployment code itself works, but I think the issue was that there were multiple instances of it running. The surge.sh deployment cannot perfectly pinpoint the exact workflow run to download the artifacts for.
One way is to not trigger too many CI runs within a short time frame. If deployment fails again, we can just trigger it again by closing and reopening the PR.

Can you try to look into a fix for it? As it is affecting our normal usage.

Instead of uploading artifacts into one position. Is modifying the path or name helping, different repo have a different paths?
image

Just look into it first.

@dcshzj And since I will be merging this PR, you may open an issue to keep the discussion.

@fzdy1914 fzdy1914 merged commit cf82a71 into reposense:master Feb 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add gradle instructions in the workflow section of Developer Guide
4 participants