-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
release md v1 #370
Merged
Merged
release md v1 #370
Changes from 15 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
f045ed4
release md v1
MichalPaszowski 68f4bba
more elaborate description of deploy process and chaining of commands…
MichalPaszowski 21be922
release draft
MichalPaszowski 3bd5ec2
Update release.md
MichalPaszowski 4d26f09
Update release.md
MichalPaszowski 888f27c
prettier stuff
MichalPaszowski 4f4fb26
prettier stuff
MichalPaszowski 14cf655
work!
MichalPaszowski 9661db9
file rename
MichalPaszowski 08e03ff
readme link
MichalPaszowski 87f1c35
typo
MichalPaszowski 0a3d208
rename 1
MichalPaszowski 10ada2c
rename 2
MichalPaszowski 095bb11
rename 3
MichalPaszowski aa60e34
rename 4
MichalPaszowski c49c795
Revert "prettier stuff"
MichalPaszowski File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,32 @@ | ||
**Design system - build and deploy HOWTO** | ||
|
||
To deploy a package to the npm you need to be logged in to an npm in your console. To confirm that you are logged in, you can use `npm whoami`. If you are not, use `npm login` and follow the instructions. | ||
|
||
To deploy you just have to do 'npm run deploy'. It will execute several commands you can run separately if you wish, namely: | ||
MichalPaszowski marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- 'check' - fire up linter and unit tests that are provided per package | ||
- 'prettier' - format the code across the packages | ||
- 'predeploy' - clean up old dist files and build new ones. | ||
- and finally deploy files to npm. | ||
sgraczyk marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
When deploying to npm you will have to decide how to version your changes. Currently we are on the verge of deploying first mayor version of DS and because of that we use following convention `1.0.0-alpha.xx` where `xx` is the revision of current build. After release we will follow SemVer. | ||
|
||
Example: | ||
|
||
1 Choose "Custom Prerelease" | ||
<img width="456" alt="lerna1" src="https://user-images.githubusercontent.com/7773964/182622782-a09b3cce-58a2-4d92-9eef-7dbf56ee3a44.png"> | ||
2 Accept suggested version | ||
<img width="574" alt="lerna2" src="https://user-images.githubusercontent.com/7773964/182622849-779ae83b-1943-44fd-b2de-6619700c8540.png"> | ||
3 Confirm | ||
<img width="680" alt="lerna3" src="https://user-images.githubusercontent.com/7773964/182622918-ee484e9e-8237-422a-8252-05f02a0332b1.png"> | ||
|
||
**Keep in mind that package won't be versioned if it is not changed, and changed package will catch up with other packages in versioning.** For example current version of package `react-components` is `1.0.0-alpha.17` but `icons` lag behind a bit and are at `1.0.0-alpha.15` because no changes has been made since two deploys. If you make some changes in `react-components` and in `icons` both packages will get `1.0.0-alpha.18` version. | ||
|
||
On Github add release with correct version and change log. | ||
|
||
- Tag is added automatically by lerna, remember to target `v1` branch. | ||
- Title can be set to 'What's Changed'. | ||
- In the change log mention packages changed and link the pull requests that are part of a release. Please follow the style used for previous releases (including author, PR, issue, and title info). | ||
|
||
Example of correctly filled release note: | ||
<img width="894" alt="correct_release" src="https://user-images.githubusercontent.com/7773964/182624431-232d6cea-9d0c-4455-afd9-365c88a1ab57.png"> |
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.