From Fedora Project Wiki

m (Intermediary tasks -> Code change tasks)
(re-work the structure)
Line 17: Line 17:
</pre>
</pre>


== Git branching ==
== Switch Git branch ==
All the changes must be done in a correct git branch.


All the changes must be done in a correct git branch. The description below documents the process.
<ul>
<li>If you want to create a new ''X.Y.0'' major or minor release, create a new ''release branch'':
<pre>git checkout -b release-X.Y master</pre></li>
<li>If you want to create a new revision release ''X.Y.Z'', switch to a corresponding existing release branch:
<pre>git checkout release-X.Y</pre>
and apply all hotfixes you have prepared.</li>
</ul>


=== Major or minor releases ===
== Update {{filename|autoqa.spec}} ==
 
AutoQA uses ''release branches'' for every major or minor release. That means before tagging a new release a new branch is always created. If we want to create new X.Y.0 release:
 
<ol>
<li>Create new release branch: <pre>git checkout -b release-X.Y master</pre></li>
<li>[[#Update autoqa.spec|Update the {{filename|autoqa.spec}} file and commit]]</li>
<li>[[#Cherry-pick to master|Cherry-pick the last commit to master]]</li>
<li>Tag new release:<pre>git tag vX.Y.0 release-X.Y</pre></li>
<li>Push changes to remote repository:<pre>git push --tags origin master release-X.Y</pre></li>
</ol>
 
{{admon/tip|Time of branching|It is possible to create ''release-X.Y'' branch immediately before tagging ''X.Y.0'' release, or it is possible to do it much earlier - then we can use ''master'' for further heavy development and ''release-X.Y'' for stabilization of the current features.}}
 
=== Revision releases ===
 
All revision releases simply mean committing relevant changesets to the relevant release branch and tagging a new release:
 
<ol>
<li>Switch to correct release branch: <pre>git checkout release-X.Y</pre></li>
<li>Commit the hotfixes you have prepared</li>
<li>[[#Update autoqa.spec|Update the {{filename|autoqa.spec}} file and commit]]</li>
<li>Tag new release:<pre>git tag vX.Y.Z</pre></li>
<li>Push changes to remote repository:<pre>git push --tags origin release-X.Y</pre></li>
</ol>
 
== Code change tasks ==
This section details some coding tasks. Not all of them may be required, see the process description in [[#Git branching]].
 
=== Update {{filename|autoqa.spec}} ===
Every new release must be mentioned in the rpm {{filename|spec}} file.
Every new release must be mentioned in the rpm {{filename|spec}} file.


Line 56: Line 34:
# Locally commit the changes <pre>git commit autoqa.spec</pre>
# Locally commit the changes <pre>git commit autoqa.spec</pre>


=== Cherry-pick to master ===
== Tag the release ==
After you tag the release on the release branch, you may want to cherry-pick the {{filename|autoqa.spec}} change (e.g. tagged with ''release-X.Y'' tag) into the master branch.
The last commit (changing the {{filename|autoqa.spec}} file) must be tagged to mark the release.
 
# Tag the commit: <pre>git tag vX.Y.Z</pre>
# Check that the tag was applied to the correct commit by inspecting: <pre>git log --decorate=full</pre>
 
== Cherry-pick to master ==
After you tag the release on the release branch, you will want to cherry-pick the {{filename|autoqa.spec}} change (now tagged with ''vX.Y.Z'' tag) into the master branch.


# Change to the ''master'' branch <pre>git checkout master</pre>
# Change to the ''master'' branch <pre>git checkout master</pre>
# Cherry-pick the updated {{filename|autoqa.spec}} change <pre>git cherry-pick release-X.Y</pre>
# Cherry-pick the updated {{filename|autoqa.spec}} change <pre>git cherry-pick vX.Y.Z</pre>


== Release tasks ==
== Push changes to remote repository ==
It's time now to push all the changes to the shared remote ''origin'' repository.


=== Upload tarball ===
# Push the release branch changes: <pre>git push --tags origin release-X.Y</pre>
# If you modified the ''master'' branch (i.e. for major or minor releases), push it too: <pre>git push --tags origin master</pre>
 
== Upload tarball ==
Like many projects, the appropriate method to release a new version is by tarball.  Once you have tagged the release, upload a new tarball using the following commands.
Like many projects, the appropriate method to release a new version is by tarball.  Once you have tagged the release, upload a new tarball using the following commands.


Line 70: Line 58:
# Upload a new release tarball <pre>make upload</pre>
# Upload a new release tarball <pre>make upload</pre>


=== Build a source RPM ===
== Build a source RPM ==
With the tarball uploaded, it's time to package the new release as an RPM.
With the tarball uploaded, it's time to package the new release as an RPM.


Line 76: Line 64:
# Build a source package <pre>make srpm</pre>
# Build a source package <pre>make srpm</pre>


=== Build for applicable releases ===
== Build for applicable releases ==
With a source RPM created, it's time to '''build''' updated packages for any existing ''stable'' repositories.  This includes {{FedoraVersion|long|current}}, {{FedoraVersion|long|previous}} and, depending on the time of release, potentially {{FedoraVersion|long|previous2}}.  Traditionally, this step would be handled by running the {{command|koji build --tag dist-f{{FedoraVersionNumber|current}}-updates path/to/src.rpm}} command.  However, since {{package|autoqa}} is not yet packaged and available in Fedora repositories, updates are built locally using {{command|mock}}.
With a source RPM created, it's time to '''build''' updated packages for any existing ''stable'' repositories.  This includes {{FedoraVersion|long|current}}, {{FedoraVersion|long|previous}} and, depending on the time of release, potentially {{FedoraVersion|long|previous2}}.  Traditionally, this step would be handled by running the {{command|koji build --tag dist-f{{FedoraVersionNumber|current}}-updates path/to/src.rpm}} command.  However, since {{package|autoqa}} is not yet packaged and available in Fedora repositories, updates are built locally using {{command|mock}}.


Line 90: Line 78:
}}
}}


=== Create updates ===
== Create updates ==
With packages built, it's time to submit them as updates.  Traditionally, this step would be handled by using the [[Package_update_HOWTO#Working_with_packages_in_the_stable_branches|bodhi update tool]].  However, since {{package|autoqa}} is not yet packaged and available in official Fedora repositories, a [[Fedorapeople_Repos|custom package repository]] is used to deliver updates.
With packages built, it's time to submit them as updates.  Traditionally, this step would be handled by using the [[Package_update_HOWTO#Working_with_packages_in_the_stable_branches|bodhi update tool]].  However, since {{package|autoqa}} is not yet packaged and available in official Fedora repositories, a [[Fedorapeople_Repos|custom package repository]] is used to deliver updates.


Line 109: Line 97:
If we are sure we will no longer work on older releases (e.g. before ''X.Y''), we can also delete older release branches. If W < Y, then we can delete ''release-X.W'':
If we are sure we will no longer work on older releases (e.g. before ''X.Y''), we can also delete older release branches. If W < Y, then we can delete ''release-X.W'':


<pre>
<ol>
git tag --contains release-X.W # This must output some tag (like vX.W.3).  
<li>Make sure there's a tag at the tip of the branch and therefore no work is lost:
                                # It ensures there's a tag at the tip of  
<pre>git tag --contains release-X.W</pre>
                                # the branch and therefore no work is lost.
This must output some tag (like ''vX.W.3''). Otherwise the branch contains commits which are not part of any tag.</li>
git branch -D release-X.W
<li>Delete the local branch:
git push origin :release-X.W
<pre>git branch -D release-X.W</pre></li>
</pre>
<li>Delete the remote branch:
<pre>git push origin :release-X.W</pre></li>
</ol>


The same goes for deleting older major branches (branches ''release-Q.Y'' where Q < X).
The same goes for deleting older major branches (branches ''release-Q.Y'' where Q < X).

Revision as of 15:43, 11 July 2011

This page describes the process for tagging, building and deploying a new version of autoqa. This page assumes a basic understanding of rpm spec file syntax and commands such as git, mock and yum.

Numbering scheme

Each release has X.Y.Z identification denoting a major, a minor and a revision number:

  • Major number is increased when AutoQA makes incompatible changes in its test API. (Not used currently, since no stable public API has been offered yet.)
  • Minor number is increased when AutoQA adds new features.
  • Revision number is increased when AutoQA adds new hotfixes, but no new features.

Pre-requisites

You must have AutoQA source code checked out with write access (ssh:// protocol, requires gitautoqa membership):

git clone ssh://git.fedorahosted.org/git/autoqa.git
cd autoqa

Switch Git branch

All the changes must be done in a correct git branch.

  • If you want to create a new X.Y.0 major or minor release, create a new release branch:
    git checkout -b release-X.Y master
  • If you want to create a new revision release X.Y.Z, switch to a corresponding existing release branch:
    git checkout release-X.Y
    and apply all hotfixes you have prepared.

Update autoqa.spec

Every new release must be mentioned in the rpm spec file.

  1. Edit autoqa.spec by incrementing the Version and updating the %changelog
  2. Locally commit the changes
    git commit autoqa.spec

Tag the release

The last commit (changing the autoqa.spec file) must be tagged to mark the release.

  1. Tag the commit:
    git tag vX.Y.Z
  2. Check that the tag was applied to the correct commit by inspecting:
    git log --decorate=full

Cherry-pick to master

After you tag the release on the release branch, you will want to cherry-pick the autoqa.spec change (now tagged with vX.Y.Z tag) into the master branch.

  1. Change to the master branch
    git checkout master
  2. Cherry-pick the updated autoqa.spec change
    git cherry-pick vX.Y.Z

Push changes to remote repository

It's time now to push all the changes to the shared remote origin repository.

  1. Push the release branch changes:
    git push --tags origin release-X.Y
  2. If you modified the master branch (i.e. for major or minor releases), push it too:
    git push --tags origin master

Upload tarball

Like many projects, the appropriate method to release a new version is by tarball. Once you have tagged the release, upload a new tarball using the following commands.

  1. Check-out the correct tag
    git checkout vX.Y.Z
  2. Upload a new release tarball
    make upload

Build a source RPM

With the tarball uploaded, it's time to package the new release as an RPM.

  1. Check-out the correct tag
    git checkout vX.Y.Z
  2. Build a source package
    make srpm

Build for applicable releases

With a source RPM created, it's time to build updated packages for any existing stable repositories. This includes Fedora 41, Fedora 40 and, depending on the time of release, potentially Fedora 39. Traditionally, this step would be handled by running the koji build --tag dist-f41-updates path/to/src.rpm command. However, since autoqa is not yet packaged and available in Fedora repositories, updates are built locally using mock.

Update your mock configuration
You will need to update the mock configuration files in /etc/mock so that the autoqa package repositories are included. Information on autoqa package repositories is available at Install_and_configure_AutoQA.
  1. Build packages using mock for Fedora, specify version using RELEASEVER variable
    make mock-fedora RELEASEVER=41 
  2. Repeat the build procedure for all desired releases
Building for EPEL-5?
Due to changes in the filedigest algorithm, extra care is required when creating packages for EPEL-5. Be sure to set the _source_filedigest_algorithm and _binary_filedigest_algorithm for any packages used when building for EPEL-5. For convenience, a Makefile target is available to create EPEL-5 compatible packages.
make mock-epel RELEASEVER=5

Create updates

With packages built, it's time to submit them as updates. Traditionally, this step would be handled by using the bodhi update tool. However, since autoqa is not yet packaged and available in official Fedora repositories, a custom package repository is used to deliver updates.

  1. Mirror the autoqa package repository locally
    rsync -avz fedorapeople.org:/srv/repos/fedora-qa/autoqa ~/public_html/ ; cd autoqa/
  2. Add locally built packages to the desired repositories
    ./move-pkgs.sh path/to/autoqa.git/rpm-build/MOCK/*/*.rpm
    Simulating the updates-testing repository
    For pre-release or testing packages an alternative repository is available to mimic the official updates-testing Fedora repository. To submit packages into the fedora-autoqa-testing repository, add the command-line option -r testing. A complete example is included below.
    ./move-pkgs.sh -r testing path/to/autoqa.git/rpm-build/MOCK/*/*.rpm
  3. Update the yum repo metadata
    ./update-repos.sh
  4. Update remote repository with changes
     rsync -avz ~/public_html/autoqa fedorapeople.org:/srv/repos/fedora-qa/

Cleanup tasks

Purging old release branches

If we are sure we will no longer work on older releases (e.g. before X.Y), we can also delete older release branches. If W < Y, then we can delete release-X.W:

  1. Make sure there's a tag at the tip of the branch and therefore no work is lost:
    git tag --contains release-X.W
    This must output some tag (like vX.W.3). Otherwise the branch contains commits which are not part of any tag.
  2. Delete the local branch:
    git branch -D release-X.W
  3. Delete the remote branch:
    git push origin :release-X.W

The same goes for deleting older major branches (branches release-Q.Y where Q < X).