Skip to content

Commit 37c8741

Browse files
committed
update info on branch management and packae publishing
1 parent da10e10 commit 37c8741

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,11 @@ We have 4 types of major branches representing the current state:
5858

5959
We allow a few more prefixes for valid branchnames:
6060

61-
- `feature/*`: extend functionality, maintain dependencies
61+
- `feature/*`: extend functionality
6262
- `fix/*`, `bugfix/*`, `hotfix/*`: fix functionality
6363
- `release/*`: branches to finalize releases, also used to publish release candidate packages
64-
- `change/*`, `temp/*`
64+
- `change/*`, `temp/*`, `test/*`: unspecific changes, maybe only created to test something that won't end necessarily in a PR
65+
- `maintain/*`: maintain dependencies, changes created in publishing process
6566

6667
`next` and `legacy` only exist if necessary, otherwise we do not maintain those branches. Merges into `main`, `develop`, `next` and `legacy` are always managed by pull requests.
6768

@@ -117,11 +118,13 @@ After you tested the GUI elements package locally you can Clean up your applicat
117118

118119
### Process for pull requests and publishing releases
119120

120-
1. `feature/*` and `bugfix/*` branches are merged into `develop` via pull request
121-
2. `release/*`branch is created from `develop` [via GitHub interface](https://github.com/eccenca/gui-elements/actions/workflows/release-branch.yml), there will be created a pull request automatically
122-
- publish release candidates from this release branch by [manual usage of a GitHub workflow](https://github.com/eccenca/gui-elements/actions/workflows/release-candidate.yml)
123-
3. PR from release branch into `main` need to be approved
124-
- this will lead to a published package of the release
121+
1. `feature/*` and `bugfix/*` branches are merged into `develop` (or `next` and `legacy`) via pull request
122+
- to test out specific features or bugfixes via npm packages, the can be pre-released by using the ["Publish: feature/fix pre-release" action](https://github.com/eccenca/gui-elements/actions/workflows/publish-featurefix-prerelease.yml)
123+
2. `release/*`branch is created from `develop` (or `next` and `legacy`) via ["Create: release branch"](https://github.com/eccenca/gui-elements/actions/workflows/create-release-branch.yml), there will be created a pull request automatically
124+
- publish release candidates from this release branch by triggering the ["Publish: release candidate"](https://github.com/eccenca/gui-elements/actions/workflows/publish-release-candidate.yml)
125+
3. Pull request from release branch into `main` need to be approved
126+
- then ["Publish: final release "](https://github.com/eccenca/gui-elements/actions/workflows/publish-final-release.yml) can be used on `main` (or `next` and `legacy`) to publish final release packages
127+
- another PR is automatically created for changes done during publishing process
125128

126129
## License
127130

0 commit comments

Comments
 (0)