1352476 - RFE: Document on the README how to create a release tag

Status: RESOLVED FIXED

(JSS Graveyard :: Documentation, enhancement, P1)

Description

[Elio Maldonado]

Please add to the JSS JSS README file https://hg.mozilla.org/projects/jss/file/tip/README and explanation of how a JSS module maintainer creates a tag for a reelase. This could b either a note in the main text or a footnote.

This is how I once did created tag. Looking at https://hg.mozilla.org/projects/jss
...
diff
browse 	abbd61201dce
2017-03-14 08:19 -0700 	Elio Maldonado - Added tag JSS_4_4_20170313 for changeset 055aa3ce8a61
diff
browse 	055aa3ce8a61
2017-03-13 14:07 -0700 	Matthew Harmsen - Bug 1322364 - Release JSS 4.4.0 - turn off BETA, r=mharmsen JSS_4_4_20170313

In the second entry 055aa3ce8a61 is the revision that was used to create the upstream tar ball we used to rebase downstream fedora jss to what we wanted. The first entry I was done afterwards to tag the source tree, notice the 055aa3ce8a61 at the end matches the one below
The tag was created with this command hg tag --rev 055aa3ce8a61 JSS_4_4_20170313

The actual note could be expressed in more general way.

Comment 1

[Matthew Harmsen]

Elio,

This ticket can basically continue to target 4.4 (it may get done before the next JSS devel freeze, but if it doesn't, it won't break anything).

-- Matt

Comment 2

[Matthew Harmsen]

Attachment: Update README documenting source tagging strategy

Elio,

This is a first crack at describing the source code tagging strategy that we are using.  Being much more unfamiliar with HG, please make any corrections necessary.

Thanks,
-- Matt

Comment 3

[Elio Maldonado]

Comment on attachment 8862668 [details] [diff] [review]
Update README documenting  source tagging strategy

Review of attachment 8862668 [details] [diff] [review]:
-----------------------------------------------------------------

Looks good to me, only a minor request below.

::: README
@@ +161,5 @@
> +(7) Tagging the Source Code for a Release
> +
> +    During development, several releases may be made.  Consequently, it is
> +    good practice to create a "static tag" to the source code at these various
> +    points in time using the following format:

Please drop the "static" qualifier from the tag description as tags are either local or regular tags.  See https://www.mercurial-scm.org/wiki/Tag  and would just use the regular one. By default we are using regular tags. The rest of the descriptions is file.

Comment 4

[Matthew Harmsen]

Attachment: Update README documenting source tagging strategy

Elio,

Changes made, please check this patch in and close this bug.

Thanks,
-- Matt

Comment 5

[Elio Maldonado]

Pushed: https://hg.mozilla.org/projects/jss/rev/4ee5af07d6d8fd7efe60d130d3e7593f6e12e642