Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Prior to creating the release candidate, the version setting in build.sbt should contain the -SNAPSHOT keyword. Create and merge a pull request to remove this keyword in preparation for a non-snapshot release.

  2. From within the root of the Daffodil directory, execute the scripts/release-candidate.sh script, providing the release candidate label (e.g. rc1), the path to the root of apache-dist directory created above, your Apache login credentials (e.g. for https://id.apache.org), and your long format gpg key id (e.g. --keyid-format LONG), like so:

    Code Block
    languagebash
    $ ./scripts/release-candidate.sh


    The credentials are used to publish the jars to the Apache staging repo. You will also be asked to enter the password for your private gpg key created above to sign the published jars and the zip/tars . This script will perform the following actions:

    1. Create a zip of the source

    2. Create a tgz, zip, and rpm

    3. Calculate sha1, sha256, sha512 checksums of the above files

    4. Create ASCII armored detached signatures of the above files

    5. Stages jars/poms to https://repository.apache.org

    6. Create a git tag

  3. Once the script completes, you should verify all the files. This includes:

    1. Verify the checksums and signatures created in the Apache dist directories

    2. Verify the staged jars/poms at https://repository.apache.org/. To do so, visit that url, login in the top right using id.apache.org credentials, select "Staging Repositories" on the left, and find the orgapachedaffodil-XXXX repository. Inspect the "Content" tab to make sure the appropriate jars are uploaded and appear valid.

    3. Verify the git tag is correct

    If any of the above do not look correct, delete the files in Apache dist, "Drop" the published jars/poms, and delete the git tag. 

  4. After verifying all is correct, commit the changes:

    1. Commit the files in Apache dist, for example:

      Code Block
      languagebash
      svn add dev/incubator/daffodil/*
      svn ci -m "Stage Apache Daffodil (incubating) 2.0.0-rc1"


    2. Close the published Nexus files by visiting https://repository.apache.org, log in, find the release in "Staging Repositories" and select "Close".

    3. Push the git tag

      Code Block
      languagebash
      git push --tagtags asf v2.0.0-rc1


Update the Website

...

  1. In the Apache dist directory, move the release candidate files to the release directory

    Code Block
    languagebash
    svn mv dev/incubator/daffodil/2.0.0-rc1/ release/incubator/daffodil/2.0.0/
    svm ci -m "Release Apache Daffodil (incubating) 2.0.0"


  2. In the Daffodil git repository, create a signed git tag based on the release candidate tag

    Code Block
    languagebash
    git tag -as -m "Release v2.0.0" rel/v2.0.0 v2.0.0-rc1
    git push --tagtags asf rel/v2.0.0


  3. Release the published Nexus files by visiting https://repository.apache.org, log in, find the release in "Staging Repositories" and selecting "Release".

  4. Modify the website release page to have the following parameters:

    Code Block
    released: true
    artifact-root: "http://www.apache.org/dyn/closer.lua/incubator/daffodil/2.0.0/"
    checksum-root: "http://www.apache.org/dist/incubator/daffodil/2.0.0/"


  5. Give approximately 24 hours for the release files to sync to mirrors and maven central.

  6. Send an announcement email to announce@apache.org, dev@daffodil.apache.org, and users@daffodil.apache.org, (note: send three separate emails instead of one email with multiple TO/CC's), with the following template:

    Code Block
    languagetext
    Subject: [ANNOUNCE] Apache Daffodil (incubating) 2.0.0
     
    The Apache Daffodil (incubating) community is pleased to announce the
    release of version 2.0.0.
    
    Release notes and downloads are available at:
    
    https://daffodil.apache.org/releases/2.0.0/
    
    Daffodil is an open source implementation of the DFDL (Data Format
    Description Language) specification that uses DFDL schemas to parse
    fixed format data into an infoset, which is most commonly represented as
    either XML or JSON. This allows the use of well-established XML or JSON
    technologies and libraries to consume, inspect, and manipulate fixed
    format data in existing solutions. Daffodil is also capable of the
    reverse by serializing or "unparsing" an XML or JSON infoset back to the
    original data format.
    
    For more information about Daffodil visit:
    
    https://daffodil.apache.org/
    
    Regards,
    The Apache Daffodil Team
    


...