StackStorm / StackStorm/st2-packages

[INFO] How Branching works for Packages

Open
#230 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Shell
Stars
28
Forks
63
PR merge metrics
No merged PRs in 30d

Description

st2-packages repo now follows st2 branching strategy. What it means.

The Logic:
  • Inside st2-packages repo:
    • pushing to master of st2-packages repo will generate packages based on master of st2
    • pushing to v1.3 of st2-packages repo will generate packages based on v1.3 of st2
    • opening PR against master branch of st2-packages repo will use st2 master code
    • opening PR against v1.3 branch of st2-packages repo will use st2 v1.3 code
    • opening PR against any other branch of st2-packages repo will use ST2_GITREV hardcoded version in circle.yml
  • Inside st2 repo:
    • pushing to master of st2 repo will generate packages based on master of st2-packages
    • pushing to v1.3 of st2 repo will generate packages based on v1.3 of st2-packages
    • note that we don't enable CircleCI Pull Requests in st2 repo yet
Rebuild the Package Manually:

Normally pushing to v1.3 branch for any st2 or st2-packages repos will generate and deploy v1.3 staging packages.
Usually that's enough, but if you want to do that manually without pushing changes, just use CircleCI rebuild:

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue body documents branching behavior between st2 and st2-packages and manual CircleCI rebuilds, but names no documentation file or requested change. First locate where these instructions are maintained, then confirm the intended documentation update and its completion criteria with the project maintainers.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation, release
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.