Skip to content

Creating a new release

Maxime Labelle edited this page Feb 16, 2023 · 6 revisions

Developing a new release

The installer package has been replaced with our own implementation, albeit reusing the Windows Installer Custom Actions DLL that ships with MSKLC. The installer package is authored using WiX. Please, make sure to update the package version according to the detailed instructions at the top of the product.wxs file.

Publishing a new release

This repository uses AppVeyor continuous integration to build and package artifacts that must be published on each new release. The release and its assets are created automatically with the correct version.

The release must now be modified to include:

  • The fixed AZERTY NF Z71-300 Keyboard Layout title.
  • A change log.
  • A link to the french documentation.

The documentation pages must also be updated to refer to the new setup.zip download.

Updating the Release

In order to create a new release, please follow the steps outlined here:

  1. Push a version tag to the current HEAD of the master branch.
    Use a version tag with the following format: v M.m.x.y.
    git tag v1.2.0.0 master important: make sure to specify the base ref branch main.
    git push --tags origin

  2. This will trigger a new build and create a new release on the Releases page.

  3. Move the french documentation notice from the previous release to the current release.
    Or copy the following fragment:
    Veuillez consulter la procédure d’installation détaillée.

Updating the Documentation

  1. Copy the link to the setup.zip release asset to the Windows clipboard.
  2. Use Bitly or another service to shorten the copied URL.
  3. Checkout the gh-pages branch.
  4. Modify the download.md file in the gh-pages documentation branch, to update the download link from the PowerShell sample download instructions.
  5. Push those updated changes to the gh-pages branch.