Home

Any Cloud Storage (Omeka S Module)

Creating a New Release

New releases are created automatically when you push a tag to the GitHub repository. The tag must be the name of the new release you would like to create. For example, if you want to release v3.1.4, make sure all new code is included in the master branch. Additionally, check the following:

• Update CHANGELOG.md—try to adhere to Keep a Changelog` guidelines when creating a changelog.
• Update RELEASE.md—this is often simply a duplicate of the CHANGELOG.md entry for this release. However, it may include other helpful information to users of the module. This text is automatically added to the release created by the release.yml action.
• Update README.md if needed.
• Make sure composer.lock is correct. The release.yml action will use this lock file to download and zip the dependencies in the release.
• config/module.ini is automatically updated to the latest version number by the release.yml action before zipping everything up. You should update this in the repository but this is a sanity check so the zip file always includes the correct version number.

In short, make sure the branch has everything you need, update documentation and version number, and create a tag with the new version number, and the GitHub action will take over from there to package the release.