Versions Compared

Key

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

...

6.2.3. Deploy (java,c++,.net,scala) API documentation to the website

Run Script release_3[svngit]deploy_docs_to_site.sh

This script will unzip and upload file by file to SVN related to Apache Ignite site. This may take several minutes to complete. You may need to enter Apache credentials for committing changes. Example of execution:

...

Code Block
languagebash
themeRDark
$ ./release_3\[svn\]deploy_docs_to_site.sh
# Releasing 2.7.5-rc4 :: Packages #
/// list of files///
Uploading to svn ...
Authentication realm: <https://svn.apache.org:443> ASF Committers
Password for 'dpavlov': ....
/// list of files///
Documentation should be uploaded to site repository
Please check results at
https://svn.apache.org/repos/asf/ignite/site/trunk/releases

This step can be done manually 

Upload documentation to https://svn.apache.org/repos/asf/ignite/site/trunk/releases/<version>

...

languagexml

...

checkout ignite-website from GIT, copy API documentation, and push changes back.

Check results availability at https://svngitbox.apache.org/repos/asf/ignite/site/trunk/releases?p=ignite-website.git;a=tree;f=releases;hb=refs/heads/master

6.2.4. Create Release tag from RC tag

...

6.3.4. Publish technical documentation

Publish the technical documentation on the website: How to Document - Publishing to the website

6.3.5. Update references to API docs on the website, SEO updates

Update the latest APIs doc reference on ignite.apache.org:

  1. Update the new version number on the .htaccess file: RewriteRule ^releases/latest/(.*)$ /releases/2.9.0/$1 [L]
  2. Add the following tag to all .html files: <link rel="canonicalhref="https://ignite.apache.org/releases/latest/LANGUAGE-DIR/FILENAME.html" />
  3. Use the script that automates the update or contact Mauricio Stekl (mauricio@gridgain.com) who can assist with this step.
  4. Commit changes to the SVN. A patch will update all documents may have huge size, so console SVN client is recommendedGIT.

This script do some Search engine optimization (SEOupdates to new/old .html files, like adding NOINDEX metatag to older version; add canonical URL to latest docs; and add GA code.  

6.3.6. Prepare HTML release notes from text release notes

Checkout SVN GIT repository for Apache Ignite site: https://svngitbox.apache.org/repos/asf/ignite/site/trunkFor speed up this operation make sure to limit branches in checkout operation.-website.git

Just copy-paste latest release notes from previous release, replace text formatting with headers, lists items.

Place these notes to corresponding release folder, for example releases/2.7.5. If folder is absent, check results of step 6.2.3.

Commit and push changes. File should be available on the site automatically. 

...

6.3.8. Update version for generating users advices to update

Find `latest` text file in SVN in GIT repository for Apache Ignite site.

...

Prepare the cloud images and update links to them here https://ignite.apache.org/download.cgi#docker.

6.3.12. Delete previous release from dist and dev SVN directories

Delete previous releases from https://dist.apache.org/repos/dist/release/ignite/..., replace their download URLs by https://archive.apache.org/dist/ignite/...

Delete unsucessfull release candidates and packages (if any) from dev section of Apache SVN repository https://dist.apache.org/repos/dist/dev/ignite/

6.3.13. Upload NuGet packages to nuget.org

Retrieve all .nupkg files from build artifacts of step 4.5

Initial setup

You many may need to install client tools for .NET https://docs.microsoft.com/en-us/nuget/install-nuget-client-tools (download file & add it to PATH). You can use nuget.exe 4.x version (because NuGet.exe 5.0 and later require .NET Framework 4.7.2 ).

It may be required to configure nuget.exe using NuGet.Config(XML) https://docs.microsoft.com/en-us/nuget/tools/cli-ref-push for using nuget.org as default push source.

You can find configuration file under user home directory, for example, on Windows

No Format
cd %appdata%\Nuget

 Example of configuration:

Code Block
languagexml
<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
  </packageSources>
  <config>
    <add key="defaultPushSource" value="https://nuget.org/" />
  </config>
</configuration>


...

Usually this sync should be comleted completed in 4 hours after releasing repository at step 6.3.1. If it is not released, contat contact infra.

6.4. Announce release

...