Skip to content

Latest commit

 

History

History
90 lines (69 loc) · 5.21 KB

release-and-development-process.md

File metadata and controls

90 lines (69 loc) · 5.21 KB
Raw

Title: Release & Development Process Desc: aah framework project Release and Development Process. Keywords: release process, development process, dev process, release cycle

Release & Development Process

This document would give an idea about aah Development and Release Process. I will be improving process efficiency iteratively as project grow.

Table of Contents

Insights

Since v0.12.0 aah uses Go modules fully as a package management and versioning to provide stable release and development edge release framework.

  • Github Tag is Stable and Production ready.
  • Default branch is edge, Development and Pull Request happens on that. Bug fixes codebase is branched from master or edge according to nature of bug.
  • Branch master is kept as tidy codebase of aah.
  • In the being of every development iteration, package version number incremented and updated to 0.1.0-edge
  • In the release preparation package version is update from 0.1.0-edge to 0.1.0
  • Travis build, test cases and manual testing to ensure codebase is stable & ready for the release.
  • Pull Request (PR) created from branch edge to master.
  • Release tag gets created from latest commit sha of branch master, typically readme file update commit of the release.

For framework v0.11.4 and below versions, aah internally uses gopkg.in codebase for Package Versioning and commitment to provide stable release version in-addition to the user choice of package management tools like glide, govendor, etc.

Release Cycle

  • Security fix is gets addressed and released as soon as possible, refer to how to report security issues?.
  • Bug fixes and minor enhancements are planned to release on monthly basis.
    • Please Note: If zero bug fixes then this release may not happen.
  • Feature and Enhancement is planned to release every 3 to 6 months cycle.
    • Smaller feature or enhancement might get released earlier.
    • Have a look on aah Roadmap.

API Stability

aah and it's libraries will be maintained in a compatible way between major version unless some vital bugs prevent me from doing so. I don't take API changes lightly.

Note: As you know, aah is gradually marching towards v1.0.0 to freeze v1 signatures. So till then it will have breaking API changes. No need to worry, I will do my best to accommodate breaking changes in command aah migrate code.

Process to Release Framework and Library

  • Make good effort for Unit testing and code coverage
  • Check Travis Build and ensure to get green ticket on Github commit
  • Update README.md with appropriate information (status icons URLs, version no, date, etc)
  • Commit it as readme update for v<version-number> release [ci skip]
    • Typically used for creating release tag with this commit sha
    • We are building branch and master that is good enough for consistency check and release. Let's use the Travis CI resources optimally for aah project
  • Push it to repo
  • Create a PR from branch edge to master and Merge it
  • Update the Documentation on go-aah/docs repo
    • Branch master is always the latest release documentation
    • Create a branch from master for previous release
      • These previous release branch docs are accessible from https://docs.aahframework.org by version-number
      • For e.g.: new release v0.6.x so create branch called v0.5.x from master (preserving previous release docs)
    • Update the documentation on the branch master for the release and add Release Notes, Changelog and Migration Info
    • Push it go-aah/docs repo
  • Create a Release Tag and Publish
    • Tag name must comply with SemVer For example: v1.0.0, v1.0.1, etc.
    • Release Title is v<version-number> Release
    • In Describe release text box, put the links to official website for release notes, changelog, migration info. Typically https://docs.aahframework.org/release-notes.html
    • Hit the button Publish to make a release
  • Refer Broadcast section for making release announcement

Broadcast Framework Release

We have to broadcast new releases of framework and libraries on -

aah community: Framework and Libraries release.

Global Audience: Only Framework release.