Release Process

From Archivematica
Revision as of 11:30, 17 September 2018 by Ablewer (talk | contribs) (→‎Update FIDO)
Jump to navigation Jump to search

This is an outline/checklist of the process to create Archivematica & Storage service releases.


  1. Merge new features
  2. Test new features
  3. #Update PRONOM
  4. Write documentation
  5. Update dependencies
  6. Update version
  7. #Build deb/rpm packages
  8. Test packages for new installs and upgrades
  9. #Tag Release
  10. Update ansible roles
  11. Announce release


Needs to be improved!

  • Determine code freeze / call for translations process
  • Describe processes: push and pull - and when it needs to happen
  • We made a choice on how we're using Transifex to keep things simple: only one branch at a time pushed to Transifex. E.g. once SS 0.10.0 is released we have to decide if:
    1. We move Transifex to stable/0.10.x for a while so we can work on a minor release with translation fixes (e.g. 0.10.1), or
    2. We move to qa/0.11.x which would only make possible to bring new translations to SS 0.11.0.
  • Affected repositories
    • archivematica-storage-service
    • archivematica-workflow
    • archivematica-dashboard
      • Includes archivematica-fpr-admin
      • Includes appraisal-tab


PRONOM needs to be updated in our file identification tools, FIDO & Siegfried, as well as in the FPR.

Update FIDO

The FPR update currently use FIDO as a source for new PRONOM, since it is formatted nicer than PRONOM offers, so we depend on FIDO having updated their PRONOM. If that has not happened, we can generate a new formats-v##.xml by updating signatures manually. Artefactual can also update PRONOM and submit a PR to FIDO.

  1. Checkout fido from
  2. Update signatures
    • Run python2 -m fido.update_signatures from the fido repository root
  3. Add:
    • New signature file fido/conf/DROID_SignatureFile-v##.xml
    • New formats file fido/conf/formats-v##.xml
    • New PRONOM zip file fido/conf/
    • Updated fido/conf/versions.xml
  4. Remove:
    • Old signature file
    • Old formats file
    • Old PRONOM zip file
  1. Update fido/ to point to the new format_files
  2. Create pull request.
  1. * Release new version of FIDO.

Package FIDO

First, clone the am-packbuild repo. The most recent work has been done in branch dev/packages-1.6-docker, and needs to be merged into main.

Update the Makefiles available at rpm/fido/Makefile, and deb/fido/Makefile , and run make in each directory to build the packages.

Package Siegfried

First, clone the am-packbuild repo. The most recent work has been done in branch dev/packages-1.6-docker, and needs to be merged into main.

Update the Makefiles available at rpm/siegfried/Makefile, and deb/siegfried/Makefile , and run make in each directory to build the packages.

Update FPR

This process is currently more convoluted than it needs to be, and should be simplified.

This depends on FIDO having updated their PRONOM files. See #Update FIDO

  1. Generate a JSON with the current version of the FPR (for use later)
    • python testproject/ dumpdata fpr > fpr-current.json
  2. Generate a blank data migration
    • E.g. python testproject/ makemigrations --empty --name pronom_89 fpr
  3. Generate the FPR migration body. This also updates the local database's FPR with the new PRONOM IDs
    • E.g. python testproject/ import_pronom_ids path/to/fido/fido/conf/formats-v89.xml --output-filename pronom89.txt
  4. Copy the output into the blank migration above the Migration class
  5. Add the below RunPython operation into the Migration class, in the operations list
    • migrations.RunPython(data_migration),
  6. Due to a bug, fix the imports
    • Remove the apps.get_model lines
    • Import the models directly with from fpr.models import Format, FormatVersion, IDRule
  7. Commit
  8. Deploy on testing pipeline or locally


  1. Update the new entries
    • Ask to edit ONLY entries added by the latest PRONOM update otherwise the fixture won't work properly
    • Move new formats to a more appropriate category
    • Create rules & commands
    • Test with data for new formats

(End Analysts)

  1. Generate a JSON with the updated version of the FPR on the testing pipeline
    • python testproject/ dumpdata fpr > fpr-updated.json
  2. Get the updates as JSON
    • E.g. python testproject/ get_fpr_changes fpr-current.json fpr-updated.json fpr/migrations/pronom_89.json
  3. Update the migration to load the JSON updates
    • Replace the contents of the data migration function with
      • fixture_file = os.path.join(os.path.dirname(__file__), 'pronom_89.json')
      • call_command('loaddata', fixture_file, app_label='fpr')
    • Remove the direct imports from the bug
    • Remove the pk's from the entries in the JSON document.
    • Improvement Note: Because this is using loaddata, this will have problems if the FPR models are changed. A possible solution is to update get-fpr-changes to generate a migration instead of JSON
  4. Commit
  5. Merge

Update dependencies

Python Packages

metsrw and agentarchives both have Makefiles that handle most of the packaging

  1. Check for open PRs, merge as necessary
  2. Update with the new version, create a pull request, code review, merge.
  3. Tag new release, push tag
    • git push --tags
  4. Run make package
  5. make clean will delete packaging related files

Update version

  1. Update PREMIS agent to Archivematica-X.X.X
  2. Update Dashboard-Administration-Version to X.X.X
  3. Update Storage services-Admin-Version to X.X.X

Build deb/rpm packages

The am-packbuild repository has all the code related to building packages, except the building gpg keys. The steps to follow in order to build production production packages are as follow

Debian packages

  1. Clone the am-packbuild repo. Latest work is available in master
  2. Put your gpg private key into debs/GPG-KEYS-REPOS. That's the place the Dockerfile looks for it when building the environment.
  3. Update the makefile at debs/archivematica/Makefile in order to reflect version/keys you want to use.
  4. Run <make>, and the packages will be available in the build once the building finishes.
  5. Upload packages to public debian repository

Debian reposities

There are two debian repositories, one for archivematica packages, and one for dependencies. The procedure in order to create new ones, or upload packages to them, is the same:

    • Create folder for repo, and configuration file:

mkdir -p /path/to/repos/repo/conf

cat > /path/to/repos/repo/conf/distributions << EOF

Codename: trusty

Components: main

Architectures: amd64 source

SignWith: <short gpg keyid>


    • Go inside the repo, and import the packages previously uploaded with:

cd /path/to/repos/repo/

reprepro includedeb trusty /path/to/packages/*.deb

reprepro includedsc trusty /path/to/packages/*.deb

The current official repo is at

RPM Packages

  1. Package specs are available in am-packbuild/rpms
  2. There are vars in the Makefiles for version/release , so update them when needed
  3. In order to build them, just go into the directory you want to build, and run “make”

RPM Repositories

Once the packages are built, upload them to<version>/centos Sign the packages with rpm --addsign *.rpm (already signed packages will be skipped)

Go inside that dir, and as user ohbot run:

  • rpm --addsign *.rpm (already signed packages will be skipped)
  • createrepo . (For packages other than archivematica , use “centos-extras” repository)
  • gpg --detach-sign --armor repodata/repomd.xml

The first gpg command signs the rpms, and the later signs the repository content.

Development stage

In the final stages of development, the repositories for the new releases are created, but packages are signed with a development key to avoid mistakes. Once the development stage finishes, all new packages need to be rebuild using the production keys.

Development packages are built on each new commit to stable branches by Jenkins. Repositories are available at


Needs to be improved!


  • Make changes in archivematica-web.git
    • Update links
    • Add new doc repos
  • Deploy
    • Log in sites-pub as archivematica-web and run


  • Deploy
    • Log in sites-pub as archivematica-web and run


  • Release notes
  • Installation notes
  • ...


  • Twitter
  • Mailing list
  • News section in

Update ansible roles

Check that the deploy-pub vars files for archivematica are updated, and the ansible-ansiblematica-src and ansible-archivematica-pkg roles are able to deploy the new version

Tag Release

  1. Add release tags to repositories
    • Archivematica
    • Storage Service
    • FPR-admin
    • appraisal tab
    • transfer browser
    • Others?
  2. Create stable/#.x branch
  3. Delete qa/#.x branch if necessary

Release Day Checklist

Step 0: Operations Team checklist tasks are complete (as of September 2018, this is an internal Trello list).

  • At this point, there should be a release candidate that has been tested. A release candidate always precedes a tagged release. If any new issues have been uncovered, a new release candidate should be made and tested before proceeding with the rest of the steps.

Step 1: Release Captain decides whether the current release candidate is ready to release

  • Look at all recently filed issues in GitHub -- is anything concerning / relevant for this release? Does anything need to be addressed? If an issue is uncovered that does need to be fixed, this restarts the checklist back to Step 0.
  • Have automated tests passed?

Step 2: Release Captain creates a new tag for the release via gitolite (e.g. `v1.7.0` or `v0.11.0` for the Storage Service) or assigns someone else to do it.

  • Ensure you are adding the tag to the right commit! It should match the last commit of the final release candidate.

Step 3: Sysadmin (for now; hopefully Jenkins for 1.8) builds new packages using the release tag.

  • See the internal wiki for steps.

Step 4: Sysadmin copies new packages to the proper repository (e.g.,

  • See the internal wiki for steps.

Step 5: Analyst updates the Archivematica documentation links in the install / upgrade section with the correct package names and locations.

Step 6: Sysadmin updates deploy-pub to use the new links.

Step 7: Developer updates archivematica-web (managed in Gitolite / Gitlab) to show the new release.

  • See the internal wiki for steps.

Step 8: Developer changes the default branches in GitHub.

Step 9: Release Captain finalizes the release notes and adds a link to them in the GitHub release.

Step 10: Release Captain posts a notification to the Archivematica Google Group.

Step 11: All involved eat cake (for a major release) or cupcakes (for a minor release).