[jira] [Comment Edited] (ARROW-13379) [Dev][Docs] Improvements to archery docs

["Jonathan Keane (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ARROW-13379?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17383490#comment-17383490 ] 

Jonathan Keane edited comment on ARROW-13379 at 7/19/21, 6:07 PM:
------------------------------------------------------------------

Something I learned through attempting + failing (at least I think this is a constraint, maybe I'm making it up?) When the crossbow job checks out a specific hash, that hash must be in the remote that's being triggered. So if I were to sync my fork with upstream (but not push to my fork on github yet), and then use {{--arrow-sha}} to specify a hash (that is not yet pushed to my github fork), that would fail, but pushing would then make it work. (alternatively I could/should specify the remote manually with {{--arrow-remote}})  


was (Author: jonkeane):
Something I learned through attempting + failing (at least I think this is a constraint, maybe I'm making it up?) When the crossbow job checks out a specific hash, that hash must be in the remote that's being triggered. So if I were to sync my fork with upstream (but not push to my fork on github yet), and then use `--arrow-sha` to specify a hash (that is not yet pushed to my github fork), that would fail, but pushing would then make it work. (alternatively I could/should specify the remote manually with `--arrow-remote`)  

> [Dev][Docs] Improvements to archery docs
> ----------------------------------------
>
>                 Key: ARROW-13379
>                 URL: https://issues.apache.org/jira/browse/ARROW-13379
>             Project: Apache Arrow
>          Issue Type: New Feature
>          Components: Developer Tools, Documentation
>            Reporter: Neal Richardson
>            Priority: Major
>
> A running list as I try to figure out how to run archery locally:
> * dev/archery needs a README.md (even if it just links to {{docs/source/developers/archery.rst}} and {{docs/source/developers/crossbow.rst}})
> * The {{archery --help}} example output on the docs is outdated
> * {{archery crossbow --help}} shows nothing of use
> * To install crossbow, {{pip install -e "dev/archery[crossbow]"}} (note: the quotes are required on zsh shells)
> * Do I **really** need to create the queue? IME I don't I can use ursacomputing/crossbow and it just works — that's _probably_ because I have been granted permissions there. If that's the case we should explain that ("if you have permissions at ursacopmuting/crossbow you don't need to ... just clone the ursacopmuting/crossbow repo and... but if you do not have permissions, then you should ....")



--
This message was sent by Atlassian Jira
(v8.3.4#803005)