1400289 - Move release documentation in tree

Status: RESOLVED FIXED

(Testing :: geckodriver, enhancement, P1)

Description

[Andreas Tolfsen ❲:ato❳]

We have a wiki page at
https://github.com/mozilla/geckodriver/wiki/Releasing which should
be moved in tree.  It is also somewhat out of date now that
geckodriver lives in tree and needs a couple of updates.

Comment 1

[Andreas Tolfsen ❲:ato❳]

Attachment: Bug 1400289 - Add geckodriver release instructions.

This is a liberal port of the old geckodriver release instructions
that are on the GitHub wiki:

	https://github.com/mozilla/geckodriver/wiki/Releasing

Because the project's canonical home has moved to mozilla-central,
it is better to keep all documentation in one place.  Documentation
close to the source code is the best.

I have improved the release instructions in a number of ways, in
particular by describing how to make a release to GitHub/Travis from
mozilla-central.

DONTBUILD

Review commit: https://reviewboard.mozilla.org/r/180572/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/180572/

Comment 2

[Andreas Tolfsen ❲:ato❳]

Comment on attachment 8908973 [details]
Bug 1400289 - Add geckodriver release instructions.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/180572/diff/1-2/

Comment 3

[Andreas Tolfsen ❲:ato❳]

Comment on attachment 8908973 [details]
Bug 1400289 - Add geckodriver release instructions.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/180572/diff/2-3/

Comment 4

[David Burns :automatedtester]

Comment on attachment 8908973 [details]
Bug 1400289 - Add geckodriver release instructions.

https://reviewboard.mozilla.org/r/180572/#review185918

Comment 5

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Comment on attachment 8908973 [details]
Bug 1400289 - Add geckodriver release instructions.

https://reviewboard.mozilla.org/r/180572/#review185932

::: testing/geckodriver/doc/Releasing.md:67
(Diff revision 3)
> +mention of this.  Lines are optimally formatted at roughly 72 columns
> +to make the file readable in a text editor as well as rendered HTML.
> +fmt(1) does a splendid job at text formatting.
> +
> +[CHANGES.md]: ../CHANGES.md
> +[webdriver]: ../webdriver

Shouldn't this be 2 levels up?

Comment 6

[Andreas Tolfsen ❲:ato❳]

Comment on attachment 8908973 [details]
Bug 1400289 - Add geckodriver release instructions.

https://reviewboard.mozilla.org/r/180572/#review185932

> Shouldn't this be 2 levels up?

Yes it should.  Good catch!

Comment 7

[Andreas Tolfsen ❲:ato❳]

Comment on attachment 8908973 [details]
Bug 1400289 - Add geckodriver release instructions.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/180572/diff/3-4/

Comment 8

[Henrik Skupin [:whimboo][⌚️UTC+2]]

So, someone really need a git checkout and git to do a release? How would it work with Mercurial and git cinnabar? I asked because that is what most people are using.

Comment 9

[Andreas Tolfsen ❲:ato❳]

(In reply to Henrik Skupin (:whimboo) from comment #8)

> So, someone really need a git checkout and git to do a
> release? How would it work with Mercurial and git cinnabar? I
> asked because that is what most people are using.

Mercurial won’t work with checking out
httsp://github.com/mozilla/geckodriver.git unless there is a
backend, like the reverse of cinnabar, that allows Mercurial to talk
directly with git remotes.

So you need git to export testing/geckodriver/* from m-c into the
repo where Travis does releases from.

Comment 10

[Henrik Skupin [:whimboo][⌚️UTC+2]]

I see, so a partial checkout is possible and I don't have to clone the complete repo?

Comment 11

[Andreas Tolfsen ❲:ato❳]

(In reply to Henrik Skupin (:whimboo) from comment #10)

> I see, so a partial checkout is possible and I don't have to clone
> the complete repo?

I don’t understand the question.  Cloning
https://github.com/mozilla/geckodriver.git is not a big overhead.

Comment 12

[Henrik Skupin [:whimboo][⌚️UTC+2]]

(In reply to Andreas Tolfsen ‹:ato› from comment #11)
> I don’t understand the question.  Cloning
> https://github.com/mozilla/geckodriver.git is not a big overhead.

It's not about cloning the geckodriver repository but:

> So you need git to export testing/geckodriver/* from m-c into the
repo where Travis does releases from.

Maybe git cinnabar can export such a patch from a hg repository which then can be imported in geckodriver.

Anyway, it's something which should not hold us off from landing this patch.

Comment 13

[Andreas Tolfsen ❲:ato❳]

(In reply to Henrik Skupin (:whimboo) from comment #12)

> (In reply to Andreas Tolfsen ‹:ato› from comment #11)
> 
> > I don’t understand the question.  Cloning
> > https://github.com/mozilla/geckodriver.git is not a big
> > overhead.
> 
> It's not about cloning the geckodriver repository but:
> 
> > So you need git to export testing/geckodriver/* from m-c into
> > the repo where Travis does releases from.
> 
> Maybe git cinnabar can export such a patch from a hg repository
> which then can be imported in geckodriver.
> 
> Anyway, it's something which should not hold us off from landing
> this patch.

I think you may have misread the documentation.  You don’t need
git-cinnabar to do any of these steps.  You can use hg, git, or
git-cinnabar for your m-c checkout.  You need git to check code into
the GitHub geckodriver repository.

Comment 14

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/760c49597860
Add geckodriver release instructions. r=automatedtester

Comment 15

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/760c49597860