Skip to content

Commit 141c07f

Browse files
Rename master branch to stable (#2075)
* πŸ’š Rename master to stable in Github actions * πŸ“ Rename master to stable in markdown files * πŸ’š Rename master to stable in cookbook links * πŸ’š Rename master to stable in misc build scripts * πŸ“ Rename master to stable in segm. control doc * πŸ“ Revert unintentional changes to ToCs * πŸ“ Wrap stable in backticks in documentation
1 parent 0c33764 commit 141c07f

File tree

14 files changed

+41
-40
lines changed

14 files changed

+41
-40
lines changed

β€Ž.github/CONTRIBUTING.mdβ€Ž

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ This consists of code-reviewing your own pull request, following guidelines foun
8181

8282
> Confirmation from UXers that the implementation complies with what was decided during UX Refinement.
8383
84-
If the implementation of the issue resulted in visual changes - then it has to be UX reviewed. This is to make sure that the introduced changes align with the design system. We strive to have every issue that introduces visual changes UX reviewed. If this is not done and the changes are merged to master, we might recieve issues about components not being properly aligned with the design system anymore from the users of Kirby.
84+
If the implementation of the issue resulted in visual changes - then it has to be UX reviewed. This is to make sure that the introduced changes align with the design system. We strive to have every issue that introduces visual changes UX reviewed. If this is not done and the changes are merged to `stable`, we might recieve issues about components not being properly aligned with the design system anymore from the users of Kirby.
8585

8686
## Before you get coding
8787

@@ -103,7 +103,7 @@ If you got an idea for a component that you think should be part of Kirby you sh
103103
3. **Implementation:**
104104
- Make sure you have read: "[Before you get coding](#before-you-get-coding)".
105105
- Signal to others you are working on the issue by assigning yourself.
106-
- Create a branch from the [master branch](https://github.com/kirbydesign/designsystem/tree/master) following our [branch naming convention](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Branch).
106+
- Create a branch from the [stable branch](https://github.com/kirbydesign/designsystem/tree/stable) following our [branch naming convention](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Branch).
107107
- Publish a WIP implementation to Github as a draft PR and ask for feedback.
108108
- Make sure you have implemented tests following the guidelines in: "[The good: Test](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Test)".
109109
- Update the [cookbook](https://cookbook.kirby.design) with examples and showcases.
@@ -112,7 +112,7 @@ If you got an idea for a component that you think should be part of Kirby you sh
112112
- Create a pull request. If you created a draft PR during implementation you can just mark that as "ready for review".
113113
- Request that the pull request is code-reviewed.
114114
- Request that the pull request is [UX reviewed](#ux-review).
115-
- When the pull request has been approved it will be automatically merged to master via [automerge](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request).
115+
- When the pull request has been approved it will be automatically merged to `stable` via [automerge](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request).
116116
5. **Celebrate! πŸŽ‰**
117117

118118
## Checklist: I have an enhancement
@@ -133,7 +133,7 @@ If you have found a bug in Kirby you should follow these steps:
133133
3. **Implementation:**
134134
- Make sure you have read: "[Before you get coding](#before-you-get-coding)".
135135
- Signal to others you are working on the issue by assigning yourself.
136-
- Create a branch from the [master branch](https://github.com/kirbydesign/designsystem/tree/master) following our [branch naming convention](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Branch).
136+
- Create a branch from the [stable branch](https://github.com/kirbydesign/designsystem/tree/stable) following our [branch naming convention](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Branch).
137137
- Create a test that reproduces the bug following guidelines in: "[The good: Test](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Test)".
138138
- Write code to fix the bug
139139
4. **Follow steps 4 and 5 in "[Checklist: I have a component request](#checklist-i-have-a-component-request)".**
@@ -172,7 +172,7 @@ You should now be able to open `http://localhost:4200` in a browser to access th
172172

173173
[Node](https://nodejs.org/en/) is the runtime used for development.
174174

175-
The supported version of NodeJS can be found in the file [`package.json`](https://github.com/kirbydesign/designsystem/blob/master/package.json) under `engines`. At the time of writing it for example looks like this:
175+
The supported version of NodeJS can be found in the file [`package.json`](https://github.com/kirbydesign/designsystem/blob/stable/package.json) under `engines`. At the time of writing it for example looks like this:
176176

177177
```Javascript
178178
...
@@ -224,7 +224,7 @@ As with TSLint, we strongly recommend installing Prettier as a plugin for your
224224
It can however be used without an editor plugin; run `npm run prettier` to check for formatting errors, fix them by running `npm run prettier:fix` .
225225

226226
If there are changes only concerning formatting, in files you did not create - do not commit these. There is most likely something wrong with your Prettier settings.
227-
Make sure that Prettier uses the config file that is shipped with the repository ([ `.prettierrc.json` ](https://github.com/kirbydesign/designsystem/blob/master/.prettierrc.json)) and not a global configuration located on your machine.
227+
Make sure that Prettier uses the config file that is shipped with the repository ([ `.prettierrc.json` ](https://github.com/kirbydesign/designsystem/blob/stable/.prettierrc.json)) and not a global configuration located on your machine.
228228

229229
To check if the config file from the repository is used, try to alter the configuration in `.prettierrc.json` and format a file using Prettier - for example by changing `"singleQuote": true,` to `"singleQuote": false, ` .
230230
If all quotation marks are changed to `"` instead of `'` when you format, it means the repository config file is used by Prettier. Remember to revert the changes made to `.prettierrc.json` .

β€Ž.github/ISSUE_TEMPLATE/bug_report.mdβ€Ž

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,19 @@ The good issue: contains only one issue, is self-contained, is specific & unambi
4747

4848
## Checklist:
4949

50-
The following tasks should be carried out in sequence in order to follow [the process of contributing](https://github.com/kirbydesign/designsystem/blob/master/.github/CONTRIBUTING.md/#the-process-of-contributing) correctly.
50+
The following tasks should be carried out in sequence in order to follow [the process of contributing](https://github.com/kirbydesign/designsystem/blob/stable/.github/CONTRIBUTING.md/#the-process-of-contributing) correctly.
5151

5252
### Verification
5353
To make sure the bug is not intended behaviour; it should be verified by a member of team Kirby before moving on to implementation.
5454

55-
- [ ] Make sure the `NOT verified` label has been removed by a member of [team Kirby](https://github.com/kirbydesign/designsystem/blob/master/.github/SUPPORT.md#team-kirby); do not proceed until this is done
55+
- [ ] Make sure the `NOT verified` label has been removed by a member of [team Kirby](https://github.com/kirbydesign/designsystem/blob/stable/.github/SUPPORT.md#team-kirby); do not proceed until this is done
5656

5757
### Implementation
5858
The contributor who wants to implement this issue should:
5959

60-
- [ ] Make sure you have read: "[Before you get coding](https://github.com/kirbydesign/designsystem/blob/master/.github/CONTRIBUTING.md/#before-you-get-coding)".
60+
- [ ] Make sure you have read: "[Before you get coding](https://github.com/kirbydesign/designsystem/blob/stable/.github/CONTRIBUTING.md/#before-you-get-coding)".
6161
- [ ] Signal to others you are working on the issue by assigning yourself.
62-
- [ ] Create a branch from the [master branch](https://github.com/kirbydesign/designsystem/tree/master) following our [branch naming convention](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Branch).
62+
- [ ] Create a branch from the [stable branch](https://github.com/kirbydesign/designsystem/tree/stable) following our [branch naming convention](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Branch).
6363
- [ ] Create a test that reproduces the bug following guidelines in: "[The good: Test](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Test)".
6464
- [ ] Write code to fix the bug
6565

β€Ž.github/ISSUE_TEMPLATE/component-request.mdβ€Ž

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,19 @@ The good issue: contains only one issue, is self-contained, is specific & unambi
2828

2929
## Checklist:
3030

31-
The following tasks should be carried out in sequence in order to follow [the process of contributing](https://github.com/kirbydesign/designsystem/blob/master/.github/CONTRIBUTING.md/#the-process-of-contributing) correctly.
31+
The following tasks should be carried out in sequence in order to follow [the process of contributing](https://github.com/kirbydesign/designsystem/blob/stable/.github/CONTRIBUTING.md/#the-process-of-contributing) correctly.
3232

3333
### Refinement
3434

35-
- [ ] Request that the issue is [UX refined](https://github.com/kirbydesign/designsystem/blob/master/.github/CONTRIBUTING.md/#ux-refinement); do not proceed until this is done.
36-
- [ ] Request that the issue is [tech refined](https://github.com/kirbydesign/designsystem/blob/master/.github/CONTRIBUTING.md/#tech-refinement); do not proceed until this is done.
35+
- [ ] Request that the issue is [UX refined](https://github.com/kirbydesign/designsystem/blob/stable/.github/CONTRIBUTING.md/#ux-refinement); do not proceed until this is done.
36+
- [ ] Request that the issue is [tech refined](https://github.com/kirbydesign/designsystem/blob/stable/.github/CONTRIBUTING.md/#tech-refinement); do not proceed until this is done.
3737

3838
### Implementation
3939
The contributor who wants to implement this issue should:
4040

41-
- [ ] Make sure you have read: "[Before you get coding](https://github.com/kirbydesign/designsystem/blob/master/.github/CONTRIBUTING.md/#before-you-get-coding)".
41+
- [ ] Make sure you have read: "[Before you get coding](https://github.com/kirbydesign/designsystem/blob/stable/.github/CONTRIBUTING.md/#before-you-get-coding)".
4242
- [ ] Signal to others you are working on the issue by assigning yourself.
43-
- [ ] Create a branch from the [master branch](https://github.com/kirbydesign/designsystem/tree/master) following our [branch naming convention](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Branch).
43+
- [ ] Create a branch from the [stable branch](https://github.com/kirbydesign/designsystem/tree/stable) following our [branch naming convention](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Branch).
4444
- [ ] Publish a WIP implementation to Github as a draft PR and ask for feedback.
4545
- [ ] Make sure you have implemented tests following the guidelines in: "[The good: Test](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Test)".
4646
- [ ] Update the [cookbook](https://cookbook.kirby.design) with examples and showcases.

β€Ž.github/ISSUE_TEMPLATE/enhancement-request.mdβ€Ž

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,19 @@ The good issue: contains only one issue, is self-contained, is specific & unambi
3131

3232
## Checklist:
3333

34-
The following tasks should be carried out in sequence in order to follow [the process of contributing](https://github.com/kirbydesign/designsystem/blob/master/.github/CONTRIBUTING.md/#the-process-of-contributing) correctly.
34+
The following tasks should be carried out in sequence in order to follow [the process of contributing](https://github.com/kirbydesign/designsystem/blob/stable/.github/CONTRIBUTING.md/#the-process-of-contributing) correctly.
3535

3636
### Refinement
3737

38-
- [ ] Request that the issue is [UX refined](https://github.com/kirbydesign/designsystem/blob/master/.github/CONTRIBUTING.md/#ux-refinement); do not proceed until this is done.
39-
- [ ] Request that the issue is [tech refined](https://github.com/kirbydesign/designsystem/blob/master/.github/CONTRIBUTING.md/#tech-refinement); do not proceed until this is done.
38+
- [ ] Request that the issue is [UX refined](https://github.com/kirbydesign/designsystem/blob/stable/.github/CONTRIBUTING.md/#ux-refinement); do not proceed until this is done.
39+
- [ ] Request that the issue is [tech refined](https://github.com/kirbydesign/designsystem/blob/stable/.github/CONTRIBUTING.md/#tech-refinement); do not proceed until this is done.
4040

4141
### Implementation
4242
The contributor who wants to implement this issue should:
4343

44-
- [ ] Make sure you have read: "[Before you get coding](https://github.com/kirbydesign/designsystem/blob/master/.github/CONTRIBUTING.md/#before-you-get-coding)".
44+
- [ ] Make sure you have read: "[Before you get coding](https://github.com/kirbydesign/designsystem/blob/stable/.github/CONTRIBUTING.md/#before-you-get-coding)".
4545
- [ ] Signal to others you are working on the issue by assigning yourself.
46-
- [ ] Create a branch from the [master branch](https://github.com/kirbydesign/designsystem/tree/master) following our [branch naming convention](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Branch).
46+
- [ ] Create a branch from the [stable branch](https://github.com/kirbydesign/designsystem/tree/stable) following our [branch naming convention](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Branch).
4747
- [ ] Publish a WIP implementation to Github as a draft PR and ask for feedback.
4848
- [ ] Make sure you have implemented tests following the guidelines in: "[The good: Test](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Test)".
4949
- [ ] Update the [cookbook](https://cookbook.kirby.design) with examples and showcases.

β€Ž.github/PULL_REQUEST_TEMPLATE.mdβ€Ž

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This PR closes # (insert issue number here)
1919

2020
## Checklist:
2121

22-
The following tasks should be carried out in sequence in order to follow [the process of contributing](https://github.com/kirbydesign/designsystem/blob/master/.github/CONTRIBUTING.md/#the-process-of-contributing) correctly.
22+
The following tasks should be carried out in sequence in order to follow [the process of contributing](https://github.com/kirbydesign/designsystem/blob/stable/.github/CONTRIBUTING.md/#the-process-of-contributing) correctly.
2323

2424
### Reminders
2525
- [ ] Make sure you have implemented tests following the guidelines in: "[The good: Test](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Test)".
@@ -28,8 +28,8 @@ The following tasks should be carried out in sequence in order to follow [the pr
2828
### Review
2929
- [ ] Do a [self-review](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Self-review).
3030
- [ ] Request that the changes are code-reviewed
31-
- [ ] Request that the changes are [UX reviewed](https://github.com/kirbydesign/designsystem/blob/master/.github/CONTRIBUTING.md/#ux-review) (only necessary if your PR introduces visual changes)
31+
- [ ] Request that the changes are [UX reviewed](https://github.com/kirbydesign/designsystem/blob/stable/.github/CONTRIBUTING.md/#ux-review) (only necessary if your PR introduces visual changes)
3232

33-
When the pull request has been approved it will be automatically merged to master via [automerge](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request).
33+
When the pull request has been approved it will be automatically merged to `stable` via [automerge](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request).
3434

3535

β€Ž.github/workflows/build.ymlβ€Ž

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Build & Deploy Cookbook
22

33
on:
44
push: # TODO: Change to `release` event when our release workflow is in place
5-
branches: master
5+
branches: stable
66
pull_request:
77

88
defaults:
@@ -120,19 +120,19 @@ jobs:
120120
echo "Releasename: ${releasename}"
121121
echo "GH_DEPLOY_ENVIRONMENT=pr-${branchname}" >> $GITHUB_ENV
122122
echo "RELEASENAME=${releasename}" >> $GITHUB_ENV
123-
- name: Get deployment name for master branch
124-
if: github.ref == 'refs/heads/master'
123+
- name: Get deployment name for stable branch
124+
if: github.ref == 'refs/heads/stable'
125125
run: |
126126
echo "GH_DEPLOY_ENVIRONMENT=production" >> $GITHUB_ENV
127127
echo "RELEASENAME=designsystem" >> $GITHUB_ENV
128128
- name: Get hostname for feature branch
129-
if: github.ref != 'refs/heads/master'
129+
if: github.ref != 'refs/heads/stable'
130130
run: |
131131
chmod +x ./.scripts/dns.pl
132132
hostname=$(perl ./.scripts/dns.pl $DOMAIN "${RELEASENAME}")
133133
echo "HOSTNAME=${hostname}" >> $GITHUB_ENV
134-
- name: Get hostname for master branch
135-
if: github.ref == 'refs/heads/master'
134+
- name: Get hostname for stable branch
135+
if: github.ref == 'refs/heads/stable'
136136
run: echo "HOSTNAME=cookbook" >> $GITHUB_ENV
137137
- name: Create Github Deployment
138138
id: create_deployment
@@ -142,7 +142,7 @@ jobs:
142142
repository: ${{ github.repository }}
143143
ref: ${{ github.event_name == 'pull_request' && format('refs/heads/{0}', github.head_ref) || github.ref }}
144144
environment: ${{ env.GH_DEPLOY_ENVIRONMENT }}
145-
production_environment: ${{ github.ref == 'refs/heads/master' }}
145+
production_environment: ${{ github.ref == 'refs/heads/stable' }}
146146
auto_merge: false
147147
required_contexts: '[]' # Skip commit checks
148148
mediaType: '{"previews": ["flash", "ant-man"]}' # some parameters need preview: https://docs.github.com/en/rest/reference/repos#list-deployment-statuses-preview-notices

β€Ž.github/workflows/publish.ymlβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Publish new version to npm
33
on:
44
pull_request:
55
types: closed
6-
branches: master
6+
branches: stable
77
paths: 'libs/**'
88

99
defaults:

β€Ž.scripts/deploy-helm-branch.shβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ else
1313
branchname=$TRAVIS_BRANCH;
1414
fi
1515

16-
if [ "$TRAVIS_BRANCH" != "master" ] || [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
16+
if [ "$TRAVIS_BRANCH" != "stable" ] || [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
1717
branchname=${branchname//$feature\//}
1818
branchname=${branchname#?}
1919
releasename="$git_repo-${branchname//[^a-zA-Z0-9]/-}";

β€Žapps/cookbook/src/app/showcase/badge-showcase/badge-showcase.component.htmlβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ <h2>Elevation on white badges</h2>
1717
applied to the examples below by inspecting the shared styling for the badge examples:
1818
<br />
1919
<a
20-
href="https://github.com/kirbydesign/designsystem/blob/master/apps/cookbook/src/app/examples/badge-example/examples/badge-example-shared.scss"
20+
href="https://github.com/kirbydesign/designsystem/blob/stable/apps/cookbook/src/app/examples/badge-example/examples/badge-example-shared.scss"
2121
target="_blank"
2222
class="kirby-external-icon"
2323
>badge-example-shared.scss on Github</a

β€Žapps/cookbook/src/app/showcase/segmented-control-showcase/segmented-control-showcase.component.htmlβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ <h3>Default - with Badge</h3>
2424
</p>
2525
<p>
2626
<a
27-
href="https://github.com/kirbydesign/designsystem/blob/master/libs/designsystem/src/lib/components/segmented-control/segment-item.ts"
27+
href="https://github.com/kirbydesign/designsystem/blob/stable/libs/designsystem/src/lib/components/segmented-control/segment-item.ts"
2828
class="kirby-external-icon"
2929
target="_blank"
3030
>See SegmentItem on Github</a

0 commit comments

Comments
Β (0)