forked from vmware-archive/clarity
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update angular to v10 rc and publishing process
This also includes updated publishing instructions and process for Clarity. Signed-off-by: Jeremy Wilken <[email protected]>
- Loading branch information
1 parent
8886b4f
commit a43f782
Showing
15 changed files
with
562 additions
and
443 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -57,3 +57,9 @@ Thumbs.db | |
|
||
# Local Netlify folder | ||
.netlify | ||
|
||
# Yarn | ||
yarn-error.log | ||
|
||
# Release test | ||
release-test/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Publishing Clarity | ||
|
||
The workflow for building and publishing Clarity is found below. This assumes you are working on the default branch of the repository for this version. | ||
|
||
1. Run `yarn build` from the root. This will build and test everything just like a normal CI build. | ||
2. Update the version found in the root `package.json` file to the new version, then run `yarn publish:version` to sync the version across the project. | ||
3. Update the website release notes files as necessary to track changes and documentation. | ||
4. Commit the changes with format like `chore: release v4.0.0`. Also tag it with a version tag like `v4.0.0`. | ||
5. Run a publish script, depending on what type of release you are doing: | ||
|
||
- `yarn publish:latest` this is a standard release for the latest version of Clarity. | ||
- `yarn publish:next` this is a prerelease version for the next Clarity release. | ||
- `yarn publish:rc` this is a release candidate version for the next Clarity release. | ||
- `yarn publish:local` this is a test candidate for local development with verdaccio. | ||
|
||
6. Push the changes to Clarity branch on GitHub. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,47 @@ | ||
module.exports = { | ||
extends: '../../.eslintrc.js', | ||
// Only adding rules that override the defaults or enforce new standards | ||
rules: { | ||
'@typescript-eslint/no-explicit-any': 'off', // Would LOVE to turn this on | ||
'@typescript-eslint/explicit-function-return-type': 'off', // TOO MUCH WORK AT THE MOMENT | ||
'@typescript-eslint/no-use-before-define': 'off', // Lots of complaints in tests. | ||
'@typescript-eslint/no-unused-vars': 'off', // TypeScript is catching this | ||
'@typescript-eslint/no-var-requires': 'off', // Using raw-loader in Storybook | ||
'@typescript-eslint/ban-ts-ignore': 'off', // There are some quirks where we do want to use ts-ignore, but should be rare | ||
'clarity/no-barrel-imports': 'error', // Custom check to ensure we only import directly from files | ||
'jasmine/no-focused-tests': 'error', // Prevent focused tests | ||
'no-irregular-whitespace': ['error', { skipTemplates: true }], // Turn of whitespace checking inside of `` templates | ||
'no-prototype-builtins': 'off', | ||
}, | ||
overrides: [ | ||
{ | ||
files: ['*.stories.ts'], | ||
rules: { | ||
'@typescript-eslint/no-var-requires': 1, | ||
}, | ||
const OFF = 0; | ||
const WARN = 1; | ||
const ERROR = 2; | ||
|
||
const bannedTSTypes = { | ||
Array: 'Use [] instead.', | ||
Object: 'Use {} instead.', | ||
Boolean: 'Use `boolean` instead.', | ||
Number: 'Use `number` instead.', | ||
String: 'Use `string` instead.', | ||
}; | ||
|
||
const rules = { | ||
'@typescript-eslint/no-explicit-any': OFF, // Would LOVE to turn this on | ||
'@typescript-eslint/explicit-function-return-type': OFF, // TOO MUCH WORK AT THE MOMENT | ||
'@typescript-eslint/no-use-before-define': OFF, // Lots of complaints in tests. | ||
'@typescript-eslint/no-unused-vars': OFF, // TypeScript is catching this | ||
'@typescript-eslint/no-var-requires': OFF, // Using raw-loader in Storybook | ||
'@typescript-eslint/ban-ts-ignore': OFF, // There are some quirks where we do want to use ts-ignore, but should be rare | ||
'clarity/no-barrel-imports': ERROR, // Custom check to ensure we only import directly from files | ||
'jasmine/no-focused-tests': ERROR, // Prevent focused tests | ||
'no-irregular-whitespace': [ERROR, { skipTemplates: true }], // Turn of whitespace checking inside of `` templates | ||
'no-prototype-builtins': OFF, | ||
}; | ||
const overrides = [ | ||
{ | ||
files: ['*.stories.ts'], | ||
rules: { | ||
'@typescript-eslint/no-var-requires': 1, | ||
}, | ||
], | ||
}, | ||
]; | ||
|
||
const parserOptions = { | ||
project: 'tsconfig.eslint.json', | ||
tsconfigRootDir: __dirname, | ||
sourceType: 'module', | ||
}; | ||
|
||
const config = { | ||
extends: '../../.eslintrc.js', | ||
parserOptions, | ||
rules, | ||
overrides, | ||
}; | ||
|
||
module.exports = config; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"compilerOptions": { "strict": true }, | ||
"include": ["**/*.ts"], | ||
"exclude": ["dist", "node_modules"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.