Skip to content

Commit f81ef7b

Browse files
committed
feat: Implement automated package publishing via GitHub Actions and update project documentation.
1 parent d170bf7 commit f81ef7b

File tree

4 files changed

+151
-4
lines changed

4 files changed

+151
-4
lines changed

.github/workflows/publish.yml

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: Publish Components Kit
2+
3+
on:
4+
push:
5+
branches:
6+
- prod
7+
pull_request:
8+
branches:
9+
- prod
10+
11+
concurrency:
12+
group: ${{ github.workflow }}-${{ github.ref }}
13+
cancel-in-progress: true
14+
15+
jobs:
16+
test:
17+
runs-on: ubuntu-latest
18+
if: github.event_name == 'pull_request'
19+
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
with:
24+
fetch-depth: 0
25+
26+
- name: Setup Bun
27+
uses: oven-sh/setup-bun@v1
28+
with:
29+
bun-version: latest
30+
31+
- name: Install dependencies
32+
run: bun install
33+
34+
- name: Build package
35+
run: bun run build
36+
37+
- name: Dry run release
38+
run: bun run release:dry-run
39+
env:
40+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
41+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
42+
43+
release:
44+
runs-on: ubuntu-latest
45+
if: github.event_name == 'push' && github.ref == 'refs/heads/prod'
46+
47+
steps:
48+
- name: Checkout
49+
uses: actions/checkout@v4
50+
with:
51+
fetch-depth: 0
52+
token: ${{ secrets.GITHUB_TOKEN }}
53+
54+
- name: Setup Bun
55+
uses: oven-sh/setup-bun@v1
56+
with:
57+
bun-version: latest
58+
59+
- name: Install dependencies
60+
run: bun install
61+
62+
- name: Build package
63+
run: bun run build
64+
65+
- name: Release
66+
id: release
67+
run: bun run release
68+
env:
69+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
70+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
71+
GIT_AUTHOR_NAME: "github-actions[bot]"
72+
GIT_AUTHOR_EMAIL: "github-actions[bot]@users.noreply.github.com"
73+
GIT_COMMITTER_NAME: "github-actions[bot]"
74+
GIT_COMMITTER_EMAIL: "github-actions[bot]@users.noreply.github.com"

.releaserc.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
export default {
2-
branches: ["main"],
2+
branches: ["prod"],
33
repositoryUrl: "https://github.com/riligar/components-kit.git",
44
tagFormat: "v${version}",
55
plugins: [

README.md

Lines changed: 74 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,74 @@
1-
# components-kit
2-
RiLiGar Components Kit
1+
# Components Kit
2+
3+
<p align="center">
4+
<a href="https://www.npmjs.com/package/@riligar/components-kit" target="_blank"><img src="https://img.shields.io/npm/v/@riligar/components-kit.svg" alt="npm version" /></a>
5+
<a href="https://www.npmjs.com/package/@riligar/components-kit" target="_blank"><img src="https://img.shields.io/npm/dm/@riligar/components-kit.svg" alt="npm downloads" /></a>
6+
<a href="https://www.npmjs.com/package/@riligar/components-kit" target="_blank"><img src="https://img.shields.io/npm/l/@riligar/components-kit.svg" alt="license" /></a>
7+
</p>
8+
9+
A premium React component library built with Mantine and Zen Design principles.
10+
11+
## Installation
12+
13+
```bash
14+
bun add @riligar/components-kit
15+
```
16+
17+
## Setup
18+
19+
Ensure you have `@mantine/core` and `@mantine/hooks` installed. Import the global CSS in your application entry point:
20+
21+
```javascript
22+
import "@riligar/components-kit/style.css";
23+
```
24+
25+
## Basic Usage
26+
27+
```jsx
28+
import {
29+
Hero,
30+
FeatureSplit,
31+
FeaturesGrid,
32+
Pricing,
33+
FAQ,
34+
Footer,
35+
} from "@riligar/components-kit";
36+
37+
function App() {
38+
return (
39+
<>
40+
<Hero
41+
title="O fim do código e dos plugins."
42+
subtitle="Tecnologia RiLiGar"
43+
description="Suas Landing Pages no ar em 2 minutos."
44+
/>
45+
{/* ... other components */}
46+
<Footer />
47+
</>
48+
);
49+
}
50+
```
51+
52+
## Available Components
53+
54+
- **Layout & Structure**: `Header`, `Footer`, `Navbar`, `Layout`.
55+
- **Marketing Sections**: `Hero`, `SocialProof`, `FeatureSplit`, `FeaturesGrid`, `Comparison`.
56+
- **Conversion & Pricing**: `Pricing`, `FAQ`, `Testimonials`, `CTABanner`, `TrustBadge`.
57+
- **Primitives**: `SectionHeader`, `MediaBlock`, `CTAButton`.
58+
59+
## Development
60+
61+
```bash
62+
# Install dependencies
63+
bun install
64+
65+
# Start development server (demo)
66+
cd demo && bun run dev
67+
68+
# Build the library
69+
bun run build
70+
```
71+
72+
## License
73+
74+
MIT © Riligar

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
"build": "rollup -c",
1919
"dev": "rollup -c -w",
2020
"prepublishOnly": "bun run build",
21-
"release": "semantic-release"
21+
"release": "semantic-release",
22+
"release:dry-run": "semantic-release --dry-run"
2223
},
2324
"peerDependencies": {
2425
"@mantine/core": "^8.0.0",

0 commit comments

Comments
 (0)