• Getting Started
• Merging and Publishing
• React Library Application Template

Getting started

In order to run the project you will need to make sure that you have yarn installed. It must be higher than 1.22 in order to do that you must have corepack enabled. Do not just run "npm i" to install dependencies, all packages must be installed with yarn.

1. Install yarn
2. From the project root dir, run yarn or yarn install to install dependencies
3. To start the project run yarn dev
4. The storybook project should automatically run in your local browser
5. The QA storybook containing the latest Experience changes is accessible here

Publishing alpha versions

1. Bump the version in package.json using the format major.minor.patch-alpha.<yourinitials><n> See the version history for examples.
2. Run npm publish --tag alpha.

Merging and Publishing

1. Bump the version in package.json using the standard major.minor.patch. If there are breaking changes, we bump the major, new feature we bump minor and bug fixes or minor changes, we bump patch.
2. Update CHANGELOG.md.
3. After MR is approved, type shipit in the comments. Wait for shipit to merge your branch.
4. After your changes have been merged to master, switch to the master branch and pull down the new changes.
5. Run npm publish --dry-run.
6. If the dry run works, go ahead and run npm publish. Look for something like '@mx-cartographer/[email protected]' in the terminal output. Copy it and paste it to the end of git tag ex: git tag @mx-cartographer/[email protected]in the terminal. After that, run git push origin --tags and you're done.

React Library Application Template

This template is used to create projects in the Cartographer group

Create a Cartographer group project from the template

1. Go to the Cartographer group and click "New Project"
2. Click "Create from Template"
3. Open the "Groups" tab
4. Click "Use Template" in the React Library Application row
5. Enter the project name and ensure that the visitibliy is set to internal. Add a description if needed
6. Click "Create project" and you've created your project

Next steps:

Protect the Master branch

Note: A maintainer or owner will need to do this part

1. Open Settings > Repository for the repo
2. Expand the "Selected branches" section
3. For the master branch, set the "Allowed to merge" option to "Developers + Maintainers" and the "Allowed to push" option to "No one"

Merge Request Approvals

1. Open Settings > General for the repo
2. Expand the "Merge request approvals section"
3. Change approvals required to 1

Issue board

Under Issues > Boards, create a new board to track issues for that specific repo. Copy the labels/lists from the scoped issue board in the Cartographer group to create this one. The labels will be the same, but the new issue board will only shows issues created for this specific repo.