forked from filipg/gonito
76 lines
2.5 KiB
Plaintext
76 lines
2.5 KiB
Plaintext
<h1>Challenge How To
|
|
|
|
<h2>Install GEval
|
|
|
|
<p>In order to evaluate your work locally, you need the GEval tool. First, install <a href="https://docs.haskellstack.org/en/stable/README/">Haskell Stack</a>:
|
|
|
|
<pre>
|
|
curl -sSL https://get.haskellstack.org/ | sh
|
|
|
|
<p>and then install GEval itself:
|
|
|
|
<pre>
|
|
git clone git://gonito.net/geval
|
|
cd geval
|
|
stack setup
|
|
stack install
|
|
|
|
<p>(GEval will make your life easier, but is not obligatory, so if you have any trouble with installing GEval, you can skip this step, for the time being.)
|
|
|
|
<h2>Get your repo
|
|
|
|
$if not isIDSet || not isSSHUploaded
|
|
<p>You need to
|
|
$if not isIDSet
|
|
\ set up your ID
|
|
$if not isSSHUploaded
|
|
\ and
|
|
$if not isSSHUploaded
|
|
\ upload your SSH public key
|
|
\ (see <a href="@{YourAccountR}">your account</a>) if you want to have a repo hosted on Gonito.net, then:
|
|
|
|
<pre>
|
|
git clone ssh://gitolite@gonito.net/#{idToBeShown}/#{challengeName challenge}
|
|
cd #{challengeName challenge}
|
|
git pull ssh://gitolite@gonito.net/#{challengeName challenge}
|
|
git push origin master
|
|
|
|
<p>(Alternatively, you can use any other Git repo, e.g. GitHub, make sure Gonito.net has access to your repo.)
|
|
|
|
<h2>Work on your solution
|
|
|
|
<p>You need to generate your solution for the test set as <tt>test-A/out.tsv</tt>. You may also generate the solution for the dev set (<tt>dev-0/out.tsv</tt>).
|
|
|
|
<p>You can evaluate results for the dev set locally:
|
|
|
|
<pre>
|
|
cd #{challengeName challenge}
|
|
geval --test-name dev-0
|
|
|
|
<h2>Push your solution to the git repo
|
|
|
|
<p>Commit and push <tt>out.tsv</tt> files to your repo. It is also recommended to push your source codes along with <tt>out.tsv</tt> files.
|
|
|
|
<pre>
|
|
cd #{challengeName challenge}
|
|
git add dev-0/out.tsv test-A/out.tsv # also your source codes could be added
|
|
git commit -m 'my brilliant solution'
|
|
git push origin master
|
|
|
|
<h3>Repos hosted on Gonito.net
|
|
|
|
<p>If you use a repo hosted here, a submission and evaluation is triggered automatically. You'll see the evaluation results in your console while pushing.
|
|
|
|
<h3>External repos
|
|
|
|
<p>If you use an external repo (e.g. at your own of Gitolite or at GitHub), you can configure a webhook.
|
|
$maybe token <- mToken
|
|
<p>Your webook is:
|
|
<pre>
|
|
https://gonito.net/trigger-remotely?token=#{token}&branch=master&challenge=#{challengeName challenge}&url=URL_TO_YOUR_REPO
|
|
<p>(must be POSTed)
|
|
|
|
<h3>Manual submission
|
|
|
|
<p>In case other methods fail, you can submit your solution manually — go to the <a href="@{ChallengeSubmissionR $ challengeName challenge}">submit form</a>.
|