Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.96 KB

development.md

File metadata and controls

34 lines (23 loc) · 1.96 KB

Development Information

Generated API documentation is available on pkg.go.dev.

The release log is managed via GitHub.

Bugs go to JIRA.

Release Procedure

Major releases

  1. Update documentation if necessary.
  2. Bump VERSION file, commit, push (or pull request).
  3. Go to a new GitHub release draft. Use "Generate release notes" to create a list of changes. Write a short summary at the top.
  4. Go to your local clone of alidist, ensure that the branch is master and that it's up to date. Then branch out into aliecs-bump (git branch aliecs-bump).
  5. Bump the version in control.sh, control-core.sh, control-occplugin.sh and coconut.sh. Commit and push to origin/aliecs-bump (git push -u origin aliecs-bump).
  6. Submit pull request with the above to alisw/alidist.

Patch releases

  1. Update documentation if necessary.
  2. If the patch release should NOT be based on master:
  • Checkout the tag which the patch release should be based on, e.g. git checkout v1.34.0
  • Create a branch called branch_<planned_tag>, e.g. git checkout -b branch_v1.34.1.
  • Cherry-pick desired commits
  1. Bump VERSION file, commit, push (or pull request).
  2. Go to a new GitHub release draft. Use "Generate release notes" to create a list of changes. Write a short summary at the top.
  3. Go to your local clone of alidist, ensure that the branch is master and that it's up to date. Then branch out into aliecs-bump (git branch aliecs-bump).
  4. Bump the version in control.sh, control-core.sh, control-occplugin.sh and coconut.sh. Commit and push to origin/aliecs-bump (git push -u origin aliecs-bump).
  5. Submit pull request with the above to alisw/alidist.