newskit 0.0.0-e00e1f6 → 0.0.0-e02a96ba5

package/.storybook/preview.js

@@ -0,0 +1,135 @@
+import React from 'react';
+import {INITIAL_VIEWPORTS} from '@storybook/addon-viewport';
+import {DocsContext} from '@storybook/addon-docs';
+import {
+  NewsKitProvider,
+  styled,
+  getColorCssFromTheme,
+  newskitLightTheme,
+  ThemeProvider,
+} from '../src';
+import {getThemeObject} from '../src/test/theme-select-object';
+import {StoryDocsHeader, Stories} from '../src/test/storybook-comps';
+import {
+  instrumentationHandlers,
+  createEventInstrumentation,
+} from '../src/instrumentation';
+
+const BackgroundColor = styled.div`
+  position: absolute;
+  top: 0;
+  left: 0;
+  min-height: 100%;
+  width: 100%;
+  ${getColorCssFromTheme('background', 'interfaceBackground')}
+`;
+
+const StoryWrapper = styled.div`
+  padding: 16px;
+  box-sizing: border-box;
+`;
+
+const Background = ({children}) => (
+  <BackgroundColor>{children}</BackgroundColor>
+);
+
+const SKIP_GITHUB_CHECK = process.env.STORYBOOK_SKIP_PERCY_CHECK === 'true';
+
+export const parameters = {
+  actions: {argTypesRegex: '^on[A-Z].*'},
+  controls: {
+    matchers: {
+      color: /(background|color)$/i,
+      date: /Date$/,
+    },
+  },
+  viewport: {
+    viewports: INITIAL_VIEWPORTS,
+  },
+  options: {
+    storySort: {
+      method: 'alphabetical',
+      order: [
+        'Welcome',
+        'Components',
+        'Utilities',
+        'Composed',
+        'Deprecated',
+        '*',
+      ],
+    },
+  },
+  backgrounds: {
+    values: [
+      {
+        name: 'Newskit light',
+        value: '#ffffff',
+      },
+      {
+        name: 'Newskit dark',
+        value: '#2E2E2E',
+      },
+      {
+        name: 'The Sun',
+        value: '#eb1801',
+      },
+      {
+        name: 'The Times',
+        value: '#006699',
+      },
+      {
+        name: 'Virgin',
+        value: '#e10a0a',
+      },
+      {
+        name: 'The Wall Street Journal',
+        value: '#0274B6',
+      },
+      {
+        name: 'MarketWatch',
+        value: '#367F2E',
+      },
+    ],
+  },
+  docs: {
+    // We create a custom Docs page, using of our components for the header
+    page: () => {
+      // eslint-disable-next-line react-hooks/rules-of-hooks
+      const docsContext = React.useContext(DocsContext);
+      return (
+        <ThemeProvider theme={newskitLightTheme}>
+          <StoryDocsHeader context={docsContext} />
+          <Stories context={docsContext} includePrimary />
+        </ThemeProvider>
+      );
+    },
+  },
+  viewMode: 'docs',
+  percy: {
+    ...(SKIP_GITHUB_CHECK ? {include: 'skip-percy-tests'} : {}),
+  },
+};
+
+export const decorators = [
+  Story => {
+    return (
+      <StoryWrapper>
+        <Story />
+      </StoryWrapper>
+    );
+  },
+  (Story, context) => {
+    const handlers = [instrumentationHandlers.createConsoleHandler()];
+
+    return (
+      <NewsKitProvider
+        theme={getThemeObject(context?.globals?.backgrounds?.value)}
+        instrumentation={createEventInstrumentation(handlers, {})}
+      >
+        <Background>
+          <Story />
+        </Background>
+      </NewsKitProvider>
+    );
+  },
+];

package/.storybook/storybook-theme.js

@@ -0,0 +1,41 @@
+import {create} from '@storybook/theming';
+import {newskitLightTheme, compileTheme} from '../src';
+import logo from './public/newskit-logo-storybook.png';
+
+const nkTheme = compileTheme(newskitLightTheme);
+
+export default create({
+  base: 'light',
+
+  colorPrimary: nkTheme.colors.interactivePrimary030,
+  colorSecondary: nkTheme.colors.interactivePrimary030,
+
+  // UI
+  appBg: '#F5F8FF',
+  appContentBg: nkTheme.colors.interfaceBackground,
+  appBorderColor: nkTheme.colors.interface040,
+  appBorderRadius: nkTheme.borders.borderRadiusDefault,
+
+  // Typography
+  fontBase: nkTheme.fonts.fontFamily030.fontFamily,
+  fontCode: 'monospace',
+
+  // Text colors
+  textColor: nkTheme.colors.inkBase,
+  textInverseColor: nkTheme.colors.inkInverse,
+
+  // Toolbar default and active colors
+  barTextColor: nkTheme.colors.inkSubtle,
+  barSelectedColor: nkTheme.colors.interactivePrimary030,
+  barBg: nkTheme.colors.interfaceBackground,
+
+  // Form colors
+  inputBg: nkTheme.colors.interfaceBackground,
+  inputBorder: nkTheme.colors.interactiveInput020,
+  inputTextColor: nkTheme.colors.inkBase,
+  inputBorderRadius: nkTheme.borders.borderRadiusDefault,
+
+  brandTitle: 'NewsKit Storybook',
+  brandImage: logo,
+  brandTarget: '_self',
+});

package/.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      // Requires the extension Debugger for Chrome: https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome
+      "type": "chrome",
+      "request": "launch",
+      "name": "Storybook Debug",
+      "url": "http://localhost:6006",
+      "sourceMaps": true,
+      "webRoot": "${workspaceFolder}",
+      "sourceMapPathOverrides": {
+        "webpack:///*": "${webRoot}/*",
+        "webpack:///./*": "${webRoot}/*",
+        "webpack:///src/*": "${webRoot}/*",
+        "webpack:///./~/*": "${webRoot}/node_modules/*"
+      }
+    }
+  ]
+}

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+newskit@news.co.uk.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.

package/CONTRIBUTING.md

@@ -0,0 +1,131 @@
+# Contributing to NewsKit
+
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
+
+And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
+
+* Star the project
+* Tweet about it
+* Refer this project in your project's README
+* Mention the project at local meetups and tell your friends/colleagues
+
+## Table of Contents
+
+* [Code of Conduct](#code-of-conduct)
+* [I Have a Question or Enhancement Idea](#i-have-a-question-or-enhancement-idea)
+* [Suggesting Enhancements](#suggesting-enhancements)
+* [Reporting Bugs](#reporting-bugs)
+* [Your First Code Contribution](#your-first-code-contribution)
+* [Improving The Documentation](#improving-the-documentation)
+* [Submitting a Contribution](#submitting-a-contribution)
+* [The Project Team](#the-project-team)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the
+[Code of Conduct](/CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code. Please report unacceptable behaviour
+to james.spencer@news.co.uk.
+
+> ### Legal Notice
+>
+> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
+
+## Types of Contribution
+
+### I Have a Question or Enhancement Idea
+
+> If you want to ask a question, we assume that you have read the available [Documentation](https://www.newskit.co.uk/).
+
+Before you ask a question, it is best to search for existing [Issues](https://github.com/newscorp-ghfb/NewsKit/issues) and [Discussions](https://github.com/newscorp-ghfb/NewsKit/discussions) that might help you. In case you have found a suitable ticket and still need clarification, you can write your question in it. It is also advisable to search News Corp Slack (eg #newskit channel) to see if the issue has be raised before. If a question does evolve, and manifest as a bug/feature request, it can be moved to issues.
+
+If you then still feel the need to ask a question and need clarification, we recommend you:
+
+* Go to the [Discussion page](https://github.com/newscorp-ghfb/NewsKit/discussions/new/choose)
+* Select `General` for general questions or `Ideas` for enhancement ideas (but for Support, it is better to open an issue, see [Reporting Bugs](#reporting-bugs))
+* Provide as much context as you can.
+* Provide the name of your team/brand.
+
+#### Suggesting Enhancements
+
+Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, adding the component to your team's library might be better.
+
+From the [Discussion](https://github.com/newscorp-ghfb/NewsKit/discussions/new/choose) page, click Getting Started against `Ideas`.
+
+* Use a **clear and descriptive title** for the issue to identify the suggestion.
+* Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+* **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
+* You may want to **include screenshots/recordings/animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
+* **Explain why this enhancement would be useful** to most CONTRIBUTING.md users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
+
+We will then investigate the issue and get back to you.
+
+### Reporting Bugs
+
+#### Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+
+* Check if the bug has been fixed in the latest version.
+* Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://www.newskit.co.uk/). If you are looking for support, you might want to check [this section](#i-have-a-question)).
+* To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/newscorp-ghfb/NewsKit/issues?q=label%3Abug).
+* Also make sure to search News Corp Slack (eg #newskit channel) to see if other teams have reported similar issues
+* Collect information about the bug:
+* Console errors or stack trace
+* OS, Platform and Version (Windows, Linux, macOS, x86, ARM) you are using
+* Type and version of the browser
+* Possibly your input and the output
+* Can you reliably reproduce the issue? Does it affect all browsers?
+* If you can provide a link to your site, or a code sandbox, to demonstrate the issue, then that is a big help. You can use this [NewsKit 7 template for code sandbox](https://codesandbox.io/s/newskit-v7-template-w90oq3).
+
+#### How to Submit a Good Bug Report
+
+> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to james.spencer@news.co.uk.
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+* Open an [Issue](https://github.com/newscorp-ghfb/NewsKit/issues/new/choose). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+* Explain the behavior you would expect and the actual behavior.
+* Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
+* Provide the information you collected in the previous section.
+* Provide the name of your team/brand.
+
+Once it's filed:
+
+* By default, issues will have the `triage` which alerts the project team that there is a new issue that needs analysis.
+* A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and label the issue as `needs additional info`. Bugs marked `needs additional info` will not be addressed until they are reproduced.
+* If the issue is accepted, the `triage` label will be removed and the issues will be prioritised accordingly.
+
+### Your First Code Contribution
+
+* Look out for issues labelled `good first issue` as these have been pre-approved by the project team and represent an opportunity to increase your contribution experience.
+* Read through the `Pre-requisites`, `Getting Started` and `Styleguides` sections in the [README](/README.md).
+
+### Improving The Documentation
+
+* There is always scope for adding team-specific examples to [Storybook](https://storybook.newskit.co.uk/) or the Next.js-based [docs site](https://www.newskit.co.uk/), to help your team members see how to apply NewsKit in your projects. Remember that the Storybook Theme Dropdown can be used to better preview how the components will look on your site.
+
+## Submitting a Contribution
+
+### Opening a Pull Request
+
+Before making any changes, make sure you have permission to push to the NewsKit repository. You will need to request access to [this group](https://github.com/orgs/newscorp-ghfb/teams/newskit-contributors/members) to become a contributor.
+
+When you're finished with the changes, create a pull request, also known as a PR.
+
+* Fill in the sections on the PR template and label it as "Ready to Review" when you have completed all changes. This helps reviewers understand your changes as well as the purpose of your pull request.
+* Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
+* Once you submit your PR, a project team member will review your proposal. We may ask questions or request additional information.
+* We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
+* As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
+* If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.
+
+### Merging a Pull Request and Releasing it
+
+Merging to `main` branch and releasing will need to be done by a member of the project team. Once your PR is merged, your contributions will be publicly visible, as NewsKit is open source. You will not be able to use the change in your team's project until a NewsKit release has taken place though. Let the project team know how soon you need the change; otherwise you may be waiting 1-14 days for a routine release to take place.
+
+## The Project Team
+
+The NewsKit core team is a Scrum-sized team based in London and Sofia and includes designers and engineers. Keep an eye on the #newskit channel in Slack for announcements about new versions. Questions can be asked on that channel or one of the team-specific support channels.

package/Dockerfile

@@ -0,0 +1,12 @@
+# slim image used simply to reduce build download time, if problems arise just use non-slim variant.
+FROM node:16.11-bullseye-slim
+
+WORKDIR /app
+
+RUN yarn add http-server
+
+COPY package.json ./
+COPY dist-storybook ./dist-storybook
+COPY public ./public
+
+EXPOSE 6006 8081

package/LICENSE

@@ -0,0 +1,66 @@
+OPEN SOURCE
+
+This page sets out the details of the licences that apply to the open source
+software used in NewsKit. You should read and comply with the terms of these
+licences when using NewsKit.
+
+NEWS UK SOFTWARE
+
+The code that has been developed by or on behalf of News UK to form the basis
+of NewsKit (“NewsKit OSS”) is published by News UK under the 3-Clause BSD License.
+The terms of the 3-Clause BSD License are shown below.
+
+THIRD PARTY SOFTWARE
+
+NewsKit incorporates some components of open source software published by people
+other than News UK. Details of these components, and their related licences,
+are set out in the table below.
+
+The NewsKit OSS also refers, or links, to other components of open source software
+published by people other than News UK. You should ensure that you check,
+and comply with, the terms of the licences for those components before using them.
+
+There may be provisions in the licences for these third party components or NewsKit
+OSS that override aspects of News UK’s Website Terms and Conditions.
+
+NEWSKIT OSS LICENCE TERMS
+
+BSD 3-Clause License
+
+Copyright (c) 2022, News UK & Ireland Limited
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+LIST OF INCORPORATED THIRD PARTY OSS
+
+| Component / Software Name | Open Source Licence Type   | Copyright Holder                                      | Applicable Licence Terms                                                 |
+| ------------------------- | -------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------ |
+| Bitter                    | SIL Open Font License, 1.1 | Copyright 2011 The Bitter Project Authors             | OFL - [https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL] |
+| DM Mono                   | SIL Open Font License, 1.1 | Copyright 2020 The DM Mono Project Authors            | OFL - [https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL] |
+| DM Sans                   | SIL Open Font License, 1.1 | Copyright 2014-2017 Indian Type Foundry               | OFL - [https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL] |
+| Noto Sans                 | SIL Open Font License, 1.1 | Copyright 2012 Google Inc                             | OFL - [https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL] |
+| Poppins                   | SIL Open Font License, 1.1 | Copyright 2020 The Poppins Project Authors            | OFL - [https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL] |
+| Source Serif Pro          | SIL Open Font License, 1.1 | Copyright 2014, 2015, 2016 Adobe Systems Incorporated | OFL - [https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL] |

package/Makefile

@@ -0,0 +1,91 @@
+DOCKER_REGISTRY_URL ?= ncu-product-platforms
+DOCKER_REPO ?= design-system-site
+DOCKER_TAG ?= latest
+CIRCLE_SHA1 ?= 0000000000
+SHORT_GIT_HASH := $(shell echo ${CIRCLE_SHA1} | cut -c -9)
+
+# CURRENT BRANCH CHECKED OUT
+CURRENT_BRANCH = $(shell git symbolic-ref --short -q HEAD)
+
+# Cleans branch into a url friendly format
+BASE_PATH = $(shell node -p "/(^main$$)/.test('${CURRENT_BRANCH}') ? '' : require('./scripts/branch-name-to-url.js').branchNameToUrl('${CURRENT_BRANCH}')")
+
+BASE_URI = ${SITE_BASE_URL}${BASE_PATH}/
+
+install:
+	yarn install --frozen-lockfile
+
+# When changing the version, make sure it matches the one used in the `test_newskit_in_nextjs_app` CircleCI's job.
+install_cypress:
+	yarn add -D cypress@12.11.0;
+
+build_icons:
+	yarn build:icons
+
+build_components:
+	yarn build:comps
+
+build_storybook:
+	yarn build:storybook
+
+build_docs:
+	SITE_ENV=${SITE_ENV} BASE_URI=${BASE_URI} BASE_PATH=${BASE_PATH} yarn build:docs && yarn postbuild:docs
+
+build_docs_with_no_base_url:
+	SITE_ENV=${SITE_ENV} yarn build:docs && yarn postbuild:docs
+
+lint:
+	yarn lint
+
+check_broken_links_docs:
+	yarn e2e:findbrokenlinks:ci
+
+comps_visual_test:
+	yarn test:visual:comps:ci
+
+comps_visual_test_percy:
+	yarn test:visual:comps:ci:percy
+
+skip_comps_visual_test_percy:
+	yarn test:visual:comps:ci:percy:skip
+
+e2e_visual_test_docs:
+	yarn e2e:visual:docs:ci;
+
+e2e_visual_test_docs_percy:
+	yarn e2e:visual:docs:ci:percy;
+
+skip_e2e_visual_test_docs_percy:
+	yarn e2e:visual:docs:ci:percy:skip;
+
+publish_npm_dev:
+	cd dist; yarn publish --no-git-tag-version --new-version 0.0.0-${SHORT_GIT_HASH} --tag unstable;
+
+publish_npm:
+	cd dist; yarn publish --no-git-tag-version;
+
+build_docker:
+	docker build -t ncu-newskit .
+
+push_docker:
+	docker tag ncu-newskit:latest $(DOCKER_REGISTRY_URL)/$(DOCKER_REPO):$(DOCKER_TAG)
+	docker push $(DOCKER_REGISTRY_URL)/$(DOCKER_REPO):$(DOCKER_TAG)
+
+set_git_identity:
+	git config --global user.email "ncu-product-platforms@news.co.uk"
+	git config --global user.name "Product Platforms Service"
+
+bump_version:
+	git checkout main
+	git pull
+	yarn config set version-git-message "Bumping to version v%s - [skip ci]"
+	echo "Updating package.json and creating a tag for `${NEW_VERSION}`"
+	yarn version --new-version ${NEW_VERSION}
+	git push
+	git push origin v${NEW_VERSION}
+
+# The tag deleted should match the expected tag in the `only_on_trigger_release_tag` filter.
+delete_trigger_release_tag:
+	git checkout main
+	git push origin --delete trigger-release@${VERSION}
+