Skip to content

Commit 7e6a5a9

Browse files
authored
ci: make development in develop branch possible (#206)
This PR proposes to use `develop` branch as a development branch keeping `main` branch stable in case of necessary bug fixes. The proposed flow (documented in the README as well): * we make our development in `develop` branch * once we are ready to release, we make a PR from `develop` to `main` branch, after the merge new tags will be created from the main `branch` * go to first step in this list In case we need to release a bug fix - we can create a PR to main, merge it, new tags will be created, issue is solved and we can cherry-pick this commit to the `develop` branch. The similar scenario is working in the UCC repository right now and the results are quite good. We can go even further and make a develop branch a default one in this GitHub repository. This PR removes existing pre-release from the develop branch -> we don't want to confuse tags with the ones which will be released from `main` branch. And essentially it is not necessary to have a release from develop.
1 parent 1e65154 commit 7e6a5a9

File tree

4 files changed

+19
-6
lines changed

4 files changed

+19
-6
lines changed

.github/workflows/build-test-release.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
name: "build-test-release"
22
on:
3-
workflow_dispatch:
43
push:
54
branches:
65
- "main"
@@ -33,7 +32,7 @@ jobs:
3332
with:
3433
python-version: "3.7"
3534
- run: |
36-
bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/v1.6.24/scripts/download-actionlint.bash)
35+
bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/v1.6.26/scripts/download-actionlint.bash)
3736
- uses: pre-commit/action@v3.0.0
3837

3938
publish:

.licenserc.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,3 @@ header:
2424
- "README.md"
2525
- "LICENSE"
2626
- ".*"
27-
28-
comment: on-failure

.releaserc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@
1717
branches:
1818
[
1919
"+([0-9])?(.{+([0-9]),x}).x",
20-
"main",
21-
{ name: "develop", prerelease: "beta", channel: "beta" },
20+
"main"
2221
],
2322
plugins:
2423
[

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,23 @@ Workflow is used by add-ons created and managed by [addonfactory repository temp
66

77
Workflow defines jobs which perform security code scanning, execute different types of tests, build add-on package and make a GitHub release.
88

9+
## Development flow
10+
11+
* All the changes should first go to the `develop` branch (using "squash commit"), `main` branch should contain stable code
12+
* Official releases are made from `main` branch (when it's time to rollout new template changes):
13+
* create a PR from `develop` to `main`
14+
* test it
15+
* get all the approvals from the team
16+
* then merge it using "merge commit" option
17+
* If bugfix release is needed:
18+
* make a change
19+
* test it
20+
* create a PR to the `main` branch
21+
* get all the approvals from the team
22+
* merge it using "merge commit" option
23+
* backport the change back to the `develop` branch
24+
* new version of the workflow is going to be released (v4.17.0 (before) -> v4.17.1 (after)) and it will automatically applied to all the repositories
25+
926
# Troubleshooting for different workflow stages in GitHub Actions
1027

1128
## General troubleshooting

0 commit comments

Comments
 (0)