More XML formatting and GH Actions fix #61

khatchad · 2023-06-22T18:17:17Z

XML formatting was not recursing into subdirectories. Fixed.
GitHub Actions CI config was not maintaining the correct working directories. Fixed.
Use git clone directly to avoid XML formatting error in external dependencies by cloning into a temporary directory outside the project directory.
Also recurse into subdirectories for other metadata files.

We have another formatter for that.

Similar to Travis CI.

Per actions/toolkit#518 (comment).

This reverts commit 39ac40e.

This reverts commit b27e98a.

This reverts commit c7e9e96.

This reverts commit aa5261b.

Like Travis CI.

msridhar · 2023-06-22T20:56:36Z

.github/workflows/continuous-integration.yml

-        repository: wala/IDE
-        # fetch-depth: 50
-        path: ./IDE
+      run: git clone --depth=50 https://github.com/wala/IDE ${{ runner.temp }}/IDE


What is the purpose of these changes to use an explicit git clone? I don't quite get what is going on here.

Sorry for the lack of context. The XML format checker is going into the Jython3 code that is being cloned inside the project directory and causing a failure. The idea then is to move the cloned external dependencies outside the project directory, as was done in the original Travis CI configuration. However, the GitHub Actions only allows cloning in the project directory. Thus, we reverted to the explicit clone, as was also done in the original Travis CI configuration.

Relevant lines from Travis CI config:

ML/.travis.yml

Lines 6 to 7 in 6c10952

- git clone --depth=50 https://github.com/wala/IDE /tmp/IDE

- git clone https://github.com/juliandolby/jython3.git /tmp/jython3

Does it not work to keep using the checkout action but pass path: ${{ runner.temp }}/IDE instead of path: ./IDE?

It does not, unfortunately. That variable returns a path outside the project directory but in the working space.

Ok, yes, this is indeed a limitation, sigh actions/checkout#197

msridhar · 2023-06-22T23:41:25Z

.github/workflows/continuous-integration.yml

-        repository: wala/IDE
-        # fetch-depth: 50
-        path: ./IDE
+      run: git clone --depth=50 https://github.com/wala/IDE ${{ runner.temp }}/IDE


Ok, yes, this is indeed a limitation, sigh actions/checkout#197

msridhar · 2023-06-22T23:44:10Z

.github/workflows/continuous-integration.yml

-        repository: wala/IDE
-        # fetch-depth: 50
-        path: ./IDE
+      run: git clone --depth=50 https://github.com/wala/IDE ${{ runner.temp }}/IDE


Why not --depth=1?

I don't see why not. This was also in the original Travis CI config. Travis CI clones a history of 50 the get the project sources. But, I found this post. Looks like we should stick with 50?

I don't think the issue on that post is a concern for PR CI jobs. If it comes up we can switch to 50, but for now I say depth 1.

Are you sure? https://stackoverflow.com/questions/31278233/disadvantages-of-shallow-cloning-on-travis-and-other-ci-services#answer-53857834:~:text=Do%20not%20use%20a%20depth%3D1%20on%20your%20project%20for%20CI!

Do not use a depth=1 on your project for CI!

Well, I guess it was 1 before! https://github.com/actions/checkout#:~:text=%23%20Default%3A%201-,fetch%2Ddepth%3A%20%27%27,-%23%20Whether%20to

Looks like there could be a problem with tags: actions/checkout#217 (comment).

We can try 1. I don't foresee having a bunch of queued up builds.

I also really like using the concurrency setting for GitHub Actions:

https://github.com/wala/WALA/blob/89de874efbc3369097e03b85493f4a3beb8e1a44/.github/workflows/continuous-integration.yml#L7-L9

This ensures there is only one build in progress for any PR or on the master branch. If you push a new commit to the PR branch, it cancels the ongoing build before starting a new one. If we want additional safety we can go with depth=1 and also add this concurrency setting.

Yeah, we have this kind of thing on Travis CI (there, it's specified on the web and not the YAML). The problem we've had with it is for builds emanating from tags. If you have a deploy action that only works on tagged commits, then you bump the version to the SNAPSHOT version, the CI stops building the tagged version (that was supposed to be deployed) and starts building the new SNAPSHOT version. The result is that the deployment gets skipped. Otherwise, I also like the feature :).

If we ever need to do some kind of continuous deployment on GitHub Actions from tags, I'm sure we can configure it with a completely different .yml file, and the concurrency setting from one file shouldn't affect the other one.

msridhar · 2023-06-22T23:44:18Z

.github/workflows/continuous-integration.yml

-      with:
-        repository: juliandolby/jython3
-        path: ./jython3
+      run: git clone https://github.com/juliandolby/jython3.git ${{ runner.temp }}/jython3


We could do --depth=1 here too?

See #61 (comment)

See #61 (comment) :-)

khatchad added 3 commits June 22, 2023 14:02

Fix XML formatting configuration.

0529374

Format XML.

6539ab7

Fix directory handling in GitHub Actions config.

e1037d5

khatchad changed the title ~~More xml formatting and GH Actions fix~~ More XML formatting and GH Actions fix Jun 22, 2023

khatchad added 11 commits June 22, 2023 14:20

Ignore pom.xml in XML formatting.

d74b32b

We have another formatter for that.

Use /tmp in GH Actions build.

b27e98a

Similar to Travis CI.

Use ${{ runner.temp }} instead of /tmp.

39ac40e

Per actions/toolkit#518 (comment).

Revert "Use ${{ runner.temp }} instead of /tmp."

015ac51

This reverts commit 39ac40e.

Revert "Use /tmp in GH Actions build."

99d41bb

This reverts commit b27e98a.

Don't format jython3 stuff.

aa5261b

Try to exclude the specific file on the CI.

c7e9e96

Revert "Try to exclude the specific file on the CI."

2b624c0

This reverts commit c7e9e96.

Revert "Don't format jython3 stuff."

565c84f

This reverts commit aa5261b.

Use git clone directly.

7988b7a

Like Travis CI.

More XML formatting.

7135a16

khatchad marked this pull request as ready for review June 22, 2023 18:55

khatchad enabled auto-merge (squash) June 22, 2023 18:55

khatchad requested a review from msridhar June 22, 2023 18:55

Also recurse .gitgnore and markdown files.

88cab00

msridhar reviewed Jun 22, 2023

View reviewed changes

Try depth 1 for Git cloning.

2be0356

msridhar approved these changes Jun 23, 2023

View reviewed changes

khatchad merged commit 6c8e096 into master Jun 23, 2023

msridhar deleted the more_xml_formatting branch June 23, 2023 18:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

More XML formatting and GH Actions fix #61

More XML formatting and GH Actions fix #61

khatchad commented Jun 22, 2023 •

edited

Loading

msridhar Jun 22, 2023

khatchad Jun 22, 2023

khatchad Jun 22, 2023

msridhar Jun 22, 2023

khatchad Jun 22, 2023

khatchad Jun 22, 2023

msridhar Jun 22, 2023

msridhar Jun 22, 2023

msridhar Jun 22, 2023

khatchad Jun 23, 2023

msridhar Jun 23, 2023

khatchad Jun 23, 2023

khatchad Jun 23, 2023

khatchad Jun 23, 2023

msridhar Jun 23, 2023

khatchad Jun 23, 2023 •

edited

Loading

msridhar Jun 23, 2023

msridhar Jun 22, 2023

khatchad Jun 23, 2023

msridhar Jun 23, 2023

	- git clone --depth=50 https://github.com/wala/IDE /tmp/IDE
	- git clone https://github.com/juliandolby/jython3.git /tmp/jython3

More XML formatting and GH Actions fix #61

More XML formatting and GH Actions fix #61

Conversation

khatchad commented Jun 22, 2023 • edited Loading

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

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

Choose a reason for hiding this comment

khatchad Jun 23, 2023 • edited Loading

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

khatchad commented Jun 22, 2023 •

edited

Loading

khatchad Jun 23, 2023 •

edited

Loading