Skip to content

Latest commit

 

History

History
45 lines (42 loc) · 2.08 KB

RELEASE_PROCEDURE.md

File metadata and controls

45 lines (42 loc) · 2.08 KB
Raw

Airflow REST API Plugin Release Procedure

This document describes the branching procedure and how to create new releases of the project.

Release Instructions

  1. (if not already done) Create a new branch for all the changes you want in the release
    • Branch naming convention: v{VERSION}-branch
      • Example: v1.0.0-branch
    • Steps to Create Branch:
      1. Checkout the master
        • $ git checkout master
      2. Make sure your local copy of the master branch is up to date
        • $ git pull
      3. Create the branch:
        • $ git branch {BRANCH_NAME}
      4. Switch to the new branch
        • $ git checkout {BRANCH_NAME}
      5. Make any desired first commit changes
      6. Commit branch
        • $ git commit -m " Creating new branch {BRANCH_NAME} and updating documents"
      7. Push Branch
        • $ git push --set-upstream origin {BRANCH_NAME}
  2. Push all your changes into the Branch
    • For Pull Requests from External Contributors, those changes will also go into the Release Branch and not the Master
  3. Create a Pull Request to merge the changes from the Branch into Master
    • Base: Master ... Compare: {VERSION}
    • Pull Request Name: v{VERSION} branch merge
    • Include in the description all the changes that were made in the release
  4. Admin: Review the changes and approve the Pull Request
    • This will merge the changes into Master
  5. Create a Release from Master
    • Version Tag naming convention: v{VERSION}
      • Example: v1.0.0
    • Release Title: Same as Version Tag Name
    • Add a description
      • Should describe the new features, bug fixes and other updates
  6. Create a new Branch from Master for the next release
    • Same as described in #1
  7. In the new release, update the following things:
    • Within README.md
      • Add the future new release to the "Releases Available" section
      • Add the current branch that was created to the "Branches Available" section
    • Within plugins/rest_api_plugin.py
      • Update the __version__ value to the new release you're creating