Home

Welcome to the launchables wiki!

Releasing the launchables Workflow

We will use version branches to manage the versions of workflows. These will be named workflow/vX where vX is something like v1. The key rule is NEVER UPDATE A VERSION SUCH THAT IT BREAKS THE WORKFLOWS USING IT!!

New Workflow Development

Let's say that there is an existing workflow/v1 workflow branch. You are being tasked to bump up the version of Node, which requires you to update the setup-node task in the workflow.

1. Make changes on new branch off develop
2. Submit a PR targeting develop
3. Test
4. Merge PR to develop
5. Create new workflow/v2 branch based on develop.

Making minor bug fixes

This set of steps is for when you need to tweak something but are not changing anything ing the consuming repos. For example, updating build.json or bumping an action to a new better version. What you update depends on which one is based on the workflow in develop.

Let's say we have 2 workflow branches now, workflow/v1 and workflow/v2. develop is the same workflow as workflow/v2.

Updating workflow/v1

This branch is no longer up to date with develop, so we must make changes directly to this branch.

1. Make changes on new branch off workflow/v1
2. Submit a PR targeting workflow/v1
3. Test
4. Merge PR to workflow/v1

Updating workflow/v2

This branch is the same workflow as is on the develop branch. We could just make edits based on what is in workflow/v2 but when it comes time to work on workflow/v3 then you would have to incorporate all those changes. So we should always work on the "current" workflow through the develop branch.

1. Make changes on new branch off develop
2. Submit a PR targeting develop
3. Test
4. Merge PR to develop
5. Merge develop to workflow/v2