<div dir="ltr"><div dir="ltr"><div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small">Hey Foivos,</div><div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small"><br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Fri, Jul 17, 2020 at 1:23 PM Foivos Zakkak <<a href="mailto:fzakkak@redhat.com">fzakkak@redhat.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Hello all,<br>
<br>
In the mandrel repo `master` is essentially a mirror of graal's<br>
`master`. The only differences between the two<br>
(<a href="https://urldefense.com/v3/__https://github.com/oracle/graal/compare/master...graalvm:master__;!!GqivPVa7Brio!L09d1Q5z5R2NDZKbtl-6pxPWejbem8wuFuHInxJcaoKG9IPrSUGTu24DqUfJvbGyuMcq5A$" rel="noreferrer" target="_blank">https://github.com/oracle/graal/compare/master...graalvm:master</a>) are:<br>
<br>
1. An additional readme file (README-Mandrel.md)<br>
2. A header in the original Readme.md pointing to README-Mandrel.md<br>
3. Altered github issue templates<br>
4. Github workflows for syncing `master` with graal's `master` and<br>
testing it, plus some housekeeping of issues<br>
<br>
That said, the `master` branch currently serves the following purposes:<br>
<br>
1. Welcoming people to the project, informing them about it and<br>
providing issue templates for them (i.e. serving as the landing page).<br>
2. Testing graal's master nightly against upstream OpenJDK (using<br>
Mandrel's build scripts and testing procedure)<br>
3. Housekeeping issues, PRs etc. (i.e. github automation)<br>
<br>
I personally feel that the current state is not ideal and I would like<br>
to propose an alternative.<br>
<br>
<br>
Issues I see with the current approach:<br>
<br>
1. When visiting <a href="https://urldefense.com/v3/__https://github.com/graalvm/mandrel__;!!GqivPVa7Brio!L09d1Q5z5R2NDZKbtl-6pxPWejbem8wuFuHInxJcaoKG9IPrSUGTu24DqUfJvbEL2XGsNA$" rel="noreferrer" target="_blank">https://github.com/graalvm/mandrel</a> visitors are greeted<br>
with the Readme file of Graal with the additional header:<br>
<br>
# Mandrel<br>
<br>
## Welcome to the Mandrel project, please see README-Mandrel.md to learn<br>
more.<br>
<br>
It's relatively easy for someone to skip over this and struggle to<br>
understand what Mandrel is and how it defers from Graal.<br>
This will also result in following Graal's build instructions instead of<br>
Mandrel's.<br>
<br>
Instead I would prefer the landing page to show the content of<br>
README-Mandrel.md with a link (in the same repo) to Graal's readme.<br>
I believe this would make thinks crystal clear.<br>
<br>
2. When cloning with `git clone <a href="https://urldefense.com/v3/__https://github.com/graalvm/mandrel__;!!GqivPVa7Brio!L09d1Q5z5R2NDZKbtl-6pxPWejbem8wuFuHInxJcaoKG9IPrSUGTu24DqUfJvbEL2XGsNA$" rel="noreferrer" target="_blank">https://github.com/graalvm/mandrel`</a> one<br>
gets the `master` branch which is unstable in Mandrel and not that<br>
interesting since the Mandrel team is working on the latest release<br>
branch (currently mandrel/20.1) instead.<br>
<br>
<br>
Proposals:<br>
<br>
1. Make the default branch contain only a README file explaining what<br>
Mandrel is, how it relates to Graal, and how to get your hands on it.<br>
This branch will also contain any workflows related to housekeeping,<br>
syncing branches, nightly testing, etc.<br>
This branch will not contain any code. So after `git clone<br>
<a href="https://urldefense.com/v3/__https://github.com/graalvm/mandrel__;!!GqivPVa7Brio!L09d1Q5z5R2NDZKbtl-6pxPWejbem8wuFuHInxJcaoKG9IPrSUGTu24DqUfJvbEL2XGsNA$" rel="noreferrer" target="_blank">https://github.com/graalvm/mandrel`</a> and reading the README users will be<br>
asked to checkout another branch if they want to access the source code.<br>
This approach might not be addressing issue 2 sufficiently.<br>
<br>
2. Make the latest release branch (i.e. the one being actively<br>
developed, which currently is mandrel/20.1) the default branch.<br>
This will be similar to the current state with the difference that `git<br>
clone <a href="https://urldefense.com/v3/__https://github.com/graalvm/mandrel__;!!GqivPVa7Brio!L09d1Q5z5R2NDZKbtl-6pxPWejbem8wuFuHInxJcaoKG9IPrSUGTu24DqUfJvbEL2XGsNA$" rel="noreferrer" target="_blank">https://github.com/graalvm/mandrel`</a> will return something useful.<br>
This approach does not address issue 1 though. So it might need to be<br>
combined with swapping README-Mandrel.md and README.md (i.e. make<br>
README.md contain Mandrel info and point to a README-Graal.md)<br>
<br>
I personally prefer the first proposal.<br></blockquote><div><br></div><div><div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small">+1</div><br></div><div><div class="gmail_default" style="font-family:arial,helvetica,sans-serif;font-size:small">Option 1 would also stop the need to add extra commits into the mandrel's master clone of graal's master. You could just have a master clone that's identical to graal's master. The README could help address issue 2, by making it clear which branches are buildable...etc.</div></div><div><br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
What are your thoughts?<br>
Are there any objections on any of these? Or alternatives you would like<br>
to propose?<br>
<br>
Thanks,<br>
Foivos<br>
<br>
PS: This is being tracked in <a href="https://urldefense.com/v3/__https://github.com/graalvm/mandrel/issues/51__;!!GqivPVa7Brio!L09d1Q5z5R2NDZKbtl-6pxPWejbem8wuFuHInxJcaoKG9IPrSUGTu24DqUfJvbEyLP-gnQ$" rel="noreferrer" target="_blank">https://github.com/graalvm/mandrel/issues/51</a><br>
<br>
<br>
_______________________________________________<br>
GraalVM-Dev mailing list<br>
<a href="mailto:GraalVM-Dev@oss.oracle.com" target="_blank">GraalVM-Dev@oss.oracle.com</a><br>
<a href="https://oss.oracle.com/mailman/listinfo/graalvm-dev" rel="noreferrer" target="_blank">https://oss.oracle.com/mailman/listinfo/graalvm-dev</a></blockquote></div></div>