Skip to content

Latest commit

 

History

History
102 lines (70 loc) · 6.41 KB

RELEASE.md

File metadata and controls

102 lines (70 loc) · 6.41 KB
Raw

Appsody Stacks Release Process

A release in this repo represents a new version of a particular stack - denoted by the release tag. It will contain the following assets:

Steps to create a new stack release

The Appsody stacks are made available by creating a tagged GitHub release. Follow these steps to create a new release of an Appsody stack:

Trigger the release on GitHub

  1. Navigate to https://github.com/appsody/stacks/releases
  2. Click Draft a new release button
  3. Ensure the target branch is master
  4. Define a tag in the format <stack-id>-v<version> (example: java-microprofile-v0.2.4)
  5. Set a title in the format <stack-id> v<version> (example: java-microprofile v0.2.4)
  6. Describe the notable changes to the stack as release notes
  7. Tick This is a pre-release checkbox
  8. Click Publish release button

Monitor the Travis build

  1. Watch the Travis build for the release and ensure it passes
  2. Check the release artefacts to ensure these all exist:

Update the pre-release

  1. Navigate to https://github.com/appsody/stacks/releases
  2. Click on the title of the pre-release you have just created
  3. Click Edit release button
  4. Untick This is a pre-release checkbox
  5. Click Update release button

Update v1 Index (Incubator stacks only)

  1. For now we are manually updating the old appsody stacks index
  2. Create a pull request to update this file and update the index manually for the updated stack. Usually, we only need to update the version and url fields for the updated stack
  3. Submit the pull request
  4. Once the pull request is approved, merge the changes

Releasing Dependent Stacks

There is no fixed release schedule for Appsody stacks. Stacks should be released as we merge pull requests in this repo.

If a stack is extended by another stack, then each new version of the base stack must also result in a new version of the dependent stack. For example, a change to nodejs stack will need a new release of nodejs, followed by a new release of nodejs-express stack.

Appsody Stacks Release Process - Technical Overview

This document outlines the process for building, testing and releasing Appsody stacks.

appsody/stacks contains multiple stacks repos such as experimental, incubator and stable. Each repo includes several stacks. The build process allows you to build and release each stack and the indexes for each stack repo.

Travis-CI is configured to build and test the stacks and indexes on GitHub pull requests. When a GitHub release is created manually, the built and tested stacks and indexes are published on DockerHub and GitHub releases.

Build Phase

The build.sh script is a wrapper created for convenience and covers the process of identifying which stacks need to be built, builds stack images and templates, generates all repo indexes and then tests the stacks and indexes locally.

Env

The env.sh script holds the environment variables that the user can override before running the build.sh script. The script uses the default values for the environment variables, if no preset values have been set by the user.

List

This script decides which stacks need to be built and exposes that list as an environment variable called STACKS_LIST which contains a space-separated list of repo/stack.

Example:

STACKS_LIST=incubator/nodejs incubator/nodejs-express experimental/nodejs-functions

The script makes use of several Travis environment variables to determine which stacks should be built:

  1. In a pull request build, it lists stacks with modified or new stack.yaml files
  2. In a release build, it looks at the release tag and builds only the stack with matching id.
  3. If none of these criteria is matched, it will include all stacks.

Lint

This script makes use of the STACKS_LIST to validate the file structure of the stacks. It verifies that each stack contains the correct directories in the correct places e.g. image and template directory. It also does a check that each stack contains the necessary files e.g. Dockerfile, stack.yaml etc.

If a stack does not adhere to these rules, the lint will fail and exit. Otherwise the build process will continue.

Prefetch

The prefetch.sh script downloads all latest released templates and makes them available for packaging.

Package

package.sh script iterates over each repository (experimental incubator stable) and creates indexes for each repository. The indexes are based on stack.yaml file for each stack. It then iterates over the STACKS_LIST environment variable and for each stack does the following:

  • build docker image of the stack
  • tags the images with right labels based on the stack version
  • creates template archives for each template

Test

test.sh script is currently being implemented. It will run tests for each stack using the assets created by the package.sh script.

Create Codewind Index

The create_codewind_index.py script generates the index.json files from the built stacks' index.yaml files, for Codewind to consume Appsody projects. Run ./ci/create_codewind_index.py -h to see the optional arguments available to the script.

Release Phase

release.sh is invoked when a GitHub release is created with a tag manually. This script iterates over the STACKS_LIST environment variable to determine which stack(s) need to be released. It then publishes the template archives for those stacks as GitHub release assets and publishes the stack images on Appsody DockerHub. It also publishes all repo indexes as GitHub release assets.