diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4fcef607d5..67835ddb9d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -81,7 +81,7 @@ This consists of code-reviewing your own pull request, following guidelines foun > Confirmation from UXers that the implementation complies with what was decided during UX Refinement. -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. +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. ## Before you get coding @@ -103,7 +103,7 @@ If you got an idea for a component that you think should be part of Kirby you sh 3. **Implementation:** - Make sure you have read: "[Before you get coding](#before-you-get-coding)". - Signal to others you are working on the issue by assigning yourself. - - 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). + - 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). - Publish a WIP implementation to Github as a draft PR and ask for feedback. - Make sure you have implemented tests following the guidelines in: "[The good: Test](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Test)". - 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 - Create a pull request. If you created a draft PR during implementation you can just mark that as "ready for review". - Request that the pull request is code-reviewed. - Request that the pull request is [UX reviewed](#ux-review). - - 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). + - 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). 5. **Celebrate! 🎉** ## Checklist: I have an enhancement @@ -133,7 +133,7 @@ If you have found a bug in Kirby you should follow these steps: 3. **Implementation:** - Make sure you have read: "[Before you get coding](#before-you-get-coding)". - Signal to others you are working on the issue by assigning yourself. - - 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). + - 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). - Create a test that reproduces the bug following guidelines in: "[The good: Test](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Test)". - Write code to fix the bug 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 [Node](https://nodejs.org/en/) is the runtime used for development. -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: +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: ```Javascript ... @@ -224,7 +224,7 @@ As with TSLint, we strongly recommend installing Prettier as a plugin for your 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` . 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. -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. +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. 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, ` . 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` . diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 853512ea7a..711efeeb7c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -47,19 +47,19 @@ The good issue: contains only one issue, is self-contained, is specific & unambi ## Checklist: -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. +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. ### Verification To make sure the bug is not intended behaviour; it should be verified by a member of team Kirby before moving on to implementation. -- [ ] 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 +- [ ] 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 ### Implementation The contributor who wants to implement this issue should: -- [ ] Make sure you have read: "[Before you get coding](https://github.com/kirbydesign/designsystem/blob/master/.github/CONTRIBUTING.md/#before-you-get-coding)". +- [ ] Make sure you have read: "[Before you get coding](https://github.com/kirbydesign/designsystem/blob/stable/.github/CONTRIBUTING.md/#before-you-get-coding)". - [ ] Signal to others you are working on the issue by assigning yourself. -- [ ] 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). +- [ ] 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). - [ ] Create a test that reproduces the bug following guidelines in: "[The good: Test](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Test)". - [ ] Write code to fix the bug diff --git a/.github/ISSUE_TEMPLATE/component-request.md b/.github/ISSUE_TEMPLATE/component-request.md index e1e8587dda..4b951d1b59 100644 --- a/.github/ISSUE_TEMPLATE/component-request.md +++ b/.github/ISSUE_TEMPLATE/component-request.md @@ -28,19 +28,19 @@ The good issue: contains only one issue, is self-contained, is specific & unambi ## Checklist: -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. +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. ### Refinement -- [ ] 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. -- [ ] 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. +- [ ] 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. +- [ ] 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. ### Implementation The contributor who wants to implement this issue should: -- [ ] Make sure you have read: "[Before you get coding](https://github.com/kirbydesign/designsystem/blob/master/.github/CONTRIBUTING.md/#before-you-get-coding)". +- [ ] Make sure you have read: "[Before you get coding](https://github.com/kirbydesign/designsystem/blob/stable/.github/CONTRIBUTING.md/#before-you-get-coding)". - [ ] Signal to others you are working on the issue by assigning yourself. -- [ ] 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). +- [ ] 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). - [ ] Publish a WIP implementation to Github as a draft PR and ask for feedback. - [ ] Make sure you have implemented tests following the guidelines in: "[The good: Test](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Test)". - [ ] Update the [cookbook](https://cookbook.kirby.design) with examples and showcases. diff --git a/.github/ISSUE_TEMPLATE/enhancement-request.md b/.github/ISSUE_TEMPLATE/enhancement-request.md index f98eeb5ee1..7f0f2304d0 100644 --- a/.github/ISSUE_TEMPLATE/enhancement-request.md +++ b/.github/ISSUE_TEMPLATE/enhancement-request.md @@ -31,19 +31,19 @@ The good issue: contains only one issue, is self-contained, is specific & unambi ## Checklist: -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. +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. ### Refinement -- [ ] 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. -- [ ] 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. +- [ ] 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. +- [ ] 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. ### Implementation The contributor who wants to implement this issue should: -- [ ] Make sure you have read: "[Before you get coding](https://github.com/kirbydesign/designsystem/blob/master/.github/CONTRIBUTING.md/#before-you-get-coding)". +- [ ] Make sure you have read: "[Before you get coding](https://github.com/kirbydesign/designsystem/blob/stable/.github/CONTRIBUTING.md/#before-you-get-coding)". - [ ] Signal to others you are working on the issue by assigning yourself. -- [ ] 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). +- [ ] 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). - [ ] Publish a WIP implementation to Github as a draft PR and ask for feedback. - [ ] Make sure you have implemented tests following the guidelines in: "[The good: Test](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Test)". - [ ] Update the [cookbook](https://cookbook.kirby.design) with examples and showcases. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b54b41ca74..b6b6603872 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -19,7 +19,7 @@ This PR closes # (insert issue number here) ## Checklist: -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. +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. ### Reminders - [ ] 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 ### Review - [ ] Do a [self-review](https://github.com/kirbydesign/designsystem/wiki/The-Good%3A-Self-review). - [ ] Request that the changes are code-reviewed -- [ ] 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) +- [ ] 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) -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). +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). diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b38b48ec40..22536816ca 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -2,7 +2,7 @@ name: Build & Deploy Cookbook on: push: # TODO: Change to `release` event when our release workflow is in place - branches: master + branches: stable pull_request: defaults: @@ -120,19 +120,19 @@ jobs: echo "Releasename: ${releasename}" echo "GH_DEPLOY_ENVIRONMENT=pr-${branchname}" >> $GITHUB_ENV echo "RELEASENAME=${releasename}" >> $GITHUB_ENV - - name: Get deployment name for master branch - if: github.ref == 'refs/heads/master' + - name: Get deployment name for stable branch + if: github.ref == 'refs/heads/stable' run: | echo "GH_DEPLOY_ENVIRONMENT=production" >> $GITHUB_ENV echo "RELEASENAME=designsystem" >> $GITHUB_ENV - name: Get hostname for feature branch - if: github.ref != 'refs/heads/master' + if: github.ref != 'refs/heads/stable' run: | chmod +x ./.scripts/dns.pl hostname=$(perl ./.scripts/dns.pl $DOMAIN "${RELEASENAME}") echo "HOSTNAME=${hostname}" >> $GITHUB_ENV - - name: Get hostname for master branch - if: github.ref == 'refs/heads/master' + - name: Get hostname for stable branch + if: github.ref == 'refs/heads/stable' run: echo "HOSTNAME=cookbook" >> $GITHUB_ENV - name: Create Github Deployment id: create_deployment @@ -142,7 +142,7 @@ jobs: repository: ${{ github.repository }} ref: ${{ github.event_name == 'pull_request' && format('refs/heads/{0}', github.head_ref) || github.ref }} environment: ${{ env.GH_DEPLOY_ENVIRONMENT }} - production_environment: ${{ github.ref == 'refs/heads/master' }} + production_environment: ${{ github.ref == 'refs/heads/stable' }} auto_merge: false required_contexts: '[]' # Skip commit checks mediaType: '{"previews": ["flash", "ant-man"]}' # some parameters need preview: https://docs.github.com/en/rest/reference/repos#list-deployment-statuses-preview-notices diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 4399bdffcb..2f78d0ba51 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -3,7 +3,7 @@ name: Publish new version to npm on: pull_request: types: closed - branches: master + branches: stable paths: 'libs/**' defaults: diff --git a/.scripts/deploy-helm-branch.sh b/.scripts/deploy-helm-branch.sh index 83f1eedbce..7002983f6b 100644 --- a/.scripts/deploy-helm-branch.sh +++ b/.scripts/deploy-helm-branch.sh @@ -13,7 +13,7 @@ else branchname=$TRAVIS_BRANCH; fi -if [ "$TRAVIS_BRANCH" != "master" ] || [ "$TRAVIS_PULL_REQUEST" != "false" ]; then +if [ "$TRAVIS_BRANCH" != "stable" ] || [ "$TRAVIS_PULL_REQUEST" != "false" ]; then branchname=${branchname//$feature\//} branchname=${branchname#?} releasename="$git_repo-${branchname//[^a-zA-Z0-9]/-}"; diff --git a/apps/cookbook/src/app/showcase/badge-showcase/badge-showcase.component.html b/apps/cookbook/src/app/showcase/badge-showcase/badge-showcase.component.html index 2f73ee94b0..2921c41db5 100644 --- a/apps/cookbook/src/app/showcase/badge-showcase/badge-showcase.component.html +++ b/apps/cookbook/src/app/showcase/badge-showcase/badge-showcase.component.html @@ -17,7 +17,7 @@

Elevation on white badges

applied to the examples below by inspecting the shared styling for the badge examples:
badge-example-shared.scss on GithubDefault - with Badge

See SegmentItem on Github) { diff --git a/nx.json b/nx.json index 25851ea1c4..07cc63b926 100644 --- a/nx.json +++ b/nx.json @@ -31,6 +31,6 @@ } }, "affected": { - "defaultBase": "master" + "defaultBase": "stable" } } diff --git a/readme.md b/readme.md index 7914f8821a..b9c0e9c792 100644 --- a/readme.md +++ b/readme.md @@ -6,7 +6,7 @@ [![npm](https://img.shields.io/npm/v/@kirbydesign/designsystem.svg)](https://www.npmjs.com/package/@kirbydesign/designsystem) [![npm](https://img.shields.io/npm/l/@kirbydesign/designsystem.svg)](https://www.npmjs.com/package/@kirbydesign/designsystem) [![npm](https://img.shields.io/npm/dm/@kirbydesign/designsystem.svg)](https://www.npmjs.com/package/@kirbydesign/designsystem) -[![Build Status](https://travis-ci.org/kirbydesign/designsystem.svg?branch=master)](https://travis-ci.org/kirbydesign/designsystem) +[![Build Status](https://travis-ci.org/kirbydesign/designsystem.svg?branch=stable)](https://travis-ci.org/kirbydesign/designsystem) [![GitHub forks](https://img.shields.io/github/forks/kirbydesign/designsystem.svg?style=social&label=Fork)](https://github.com/kirbydesign/designsystem/fork) [![GitHub stars](https://img.shields.io/github/stars/kirbydesign/designsystem.svg?style=social&label=Star)](https://github.com/kirbydesign/designsystem/stargazers) @@ -83,6 +83,7 @@ In each `.scss` file where you need to access the Sass utility functions from Ki ``` #### Generic Print Styles (Optional) + Kirby also provides a generic print stylesheet. It includes the basics. You most likely have to add local print styles specific to your app as well. Import it into your app, e.g., in `src/styles.scss` or in your local print stylesheet if you have one: diff --git a/scripts/version_bump.sh b/scripts/version_bump.sh index e73be661a5..a6a897ec34 100755 --- a/scripts/version_bump.sh +++ b/scripts/version_bump.sh @@ -7,8 +7,8 @@ if [[ $TRAVIS_COMMIT_MESSAGE =~ "Bumping version to" ]]; then exit 0; fi -if [ "$TRAVIS_BRANCH" != "master" ] || [ "$TRAVIS_PULL_REQUEST" != "false" ]; then - echo "Not master branch - not bumping version" +if [ "$TRAVIS_BRANCH" != "stable" ] || [ "$TRAVIS_PULL_REQUEST" != "false" ]; then + echo "Not stable branch - not bumping version" exit 0; fi @@ -26,5 +26,5 @@ git remote set-url origin git@github.com:kirbydesign/designsystem.git echo "Bumping version and pushing tags" git checkout -- package.json git --no-pager diff -git checkout master +git checkout stable npm version patch -m ":bookmark: Bumping version to %s"