Skip to content

Commit

Permalink
make ci steps manual and add Contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ukorvl committed Oct 3, 2024
1 parent 11da11f commit 7637eda
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 113 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ on:
jobs:
publish:
name: Publish
permissions:
id-token: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
Expand Down
16 changes: 0 additions & 16 deletions .github/workflows/release.yaml

This file was deleted.

15 changes: 0 additions & 15 deletions .github/workflows/size-limit.yaml

This file was deleted.

31 changes: 0 additions & 31 deletions .github/workflows/storybook.yml

This file was deleted.

47 changes: 0 additions & 47 deletions .github/workflows/version.yml

This file was deleted.

32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing to UI Kit

## Storybook update

We have storybook components deployed at https://nilfoundation.github.io/ui-kit
To update storybook stand with the latest changes a developer should push the changes to the `gh-pages` branch.
Once the changes are pushed to the `gh-pages` branch, the storybook will be automatically updated.

## How to bump the version of the package?

To bump the version of the package a developer should do it locally using `npm version` command, e.g.

```bash
npm version patch
```

This command will bump the patch version of the package. After that, the developer should add this changes to their pull request. Also, don't forget to push the tags, created by `npm version` command.

```bash
git push --tags
```

## How to create a release?

Create new release at https://github.com/NilFoundation/ui-kit/releases/new
Add auto-generated release notes to the release description.
Use the version number as the release title.
Choose a tag that corresponds to the version number (you should have already pushed it)

## How to publish the package?

The package is published automatically after successful release. The CI/CD pipeline will build the package and publish it to the npm registry.
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,7 @@
"repository": "https://github.com/NilFoundation/ui-kit",
"homepage": "https://github.com/NilFoundation/ui-kit#readme",
"publishConfig": {
"access": "public",
"provenance": true
"access": "public"
},
"dependencies": {
"copy-to-clipboard": "^3.3.3",
Expand Down

0 comments on commit 7637eda

Please sign in to comment.