Skip to content

Commit a55d787

Browse files
authored
feat(ci): enable GitHub Releases and prepare v1.1.0 (#28)
## Overview Enable automatic GitHub Release creation and prepare the first release (v1.1.0) with changesets. ## Changes - Add `createGithubReleases: true` to release workflow - Add `fetch-depth: 0` for proper changelog generation - Include changeset for v1.1.0 documenting features since v1.0.1 - Add Contributing section to README with changeset workflow documentation ## What Happens After Merge 1. Release workflow detects the changeset 2. Automatically creates "Version Packages" PR 3. That PR will bump `@lytics/experience-editor` to v1.1.0 4. Merging the Version PR will publish to npm + create GitHub Release ## v1.1.0 Changelog - Support for default field values to simplify form handling - Content ranking options (affinity/popular) for recommendation widgets - Date range display condition for time-based widget targeting - Improved code quality with Biome linting and formatting
1 parent 27852f2 commit a55d787

File tree

3 files changed

+75
-0
lines changed

3 files changed

+75
-0
lines changed

.changeset/major-elephants-wash.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
"@lytics/experience-editor": minor
3+
---
4+
5+
Add field default values, content ranking, and date range display conditions
6+
7+
- Support for default field values to simplify form handling and eliminate field-specific logic
8+
- Content ranking options (affinity/popular) for recommendation widgets
9+
- Date range display condition for time-based widget targeting
10+
- Improved code quality with Biome linting and formatting
11+
- Enhanced CI pipeline with automated quality checks
12+

.github/workflows/release.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ jobs:
3030
steps:
3131
- name: Checkout code
3232
uses: actions/checkout@v4
33+
with:
34+
# Fetch all history for changesets to generate proper changelogs
35+
fetch-depth: 0
3336

3437
- name: Setup Node.js
3538
uses: actions/setup-node@v4
@@ -57,6 +60,7 @@ jobs:
5760
version: yarn version-packages
5861
commit: "chore: version packages"
5962
title: "chore: version packages"
63+
createGithubReleases: true
6064
env:
6165
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
6266
NPM_CONFIG_PROVENANCE: true

README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ Lytics Lab
1111
- [Configuration](#configuration)
1212
- [.env](#env)
1313
- [nx-cloud.env](#nx-cloudenv)
14+
- [Contributing](#contributing)
15+
- [Making Changes](#making-changes)
16+
- [Documenting Changes](#documenting-changes)
1417
- [Iterating](#iterating)
1518
- [`yarn start`](#yarn-start)
1619
- [`yarn storybook`](#yarn-storybook)
@@ -61,6 +64,62 @@ To build, run tests, storybook, etc., you may be required to create a local `nx-
6164
NX_CLOUD_ACCESS_TOKEN={VALID_READ_WRITE_TOKEN}
6265
```
6366

67+
<hr>
68+
69+
## Contributing
70+
71+
We use [Changesets](https://github.com/changesets/changesets) for version management and automated releases. See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
72+
73+
### Making Changes
74+
75+
1. Create a feature branch
76+
2. Make your changes
77+
3. Run quality checks locally:
78+
```sh
79+
yarn lint
80+
yarn typecheck
81+
yarn test
82+
yarn build
83+
```
84+
4. Create a changeset documenting your changes
85+
5. Open a pull request
86+
87+
### Documenting Changes
88+
89+
When you make user-facing changes, create a changeset:
90+
91+
```sh
92+
yarn changeset
93+
```
94+
95+
This will prompt you to:
96+
- Select which packages changed
97+
- Choose the version bump type (major/minor/patch)
98+
- Write a summary of your changes
99+
100+
The changeset will be included in your PR and used to automatically generate changelogs and version bumps when merged.
101+
102+
**Example workflow:**
103+
```sh
104+
# Make your changes
105+
git checkout -b feat/add-new-feature
106+
107+
# Create a changeset
108+
yarn changeset
109+
# Select: @lytics/experience-editor
110+
# Type: minor (for new features)
111+
# Summary: "Add support for custom themes"
112+
113+
# Commit everything
114+
git add .
115+
git commit -m "feat(experience-editor): add custom theme support"
116+
git push
117+
```
118+
119+
For more details, see [CONTRIBUTING.md](CONTRIBUTING.md).
120+
121+
<hr>
122+
64123
## Iterating
65124

66125
### `yarn start`

0 commit comments

Comments
 (0)