@namroodinc/liquid-editorial 0.1.4 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +1 -1
- package/README.md +5 -10
- package/UPGRADING.md +21 -0
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Add a decision document for every change going forward.
|
|
6
6
|
|
|
7
|
-
Every releasable change set must
|
|
7
|
+
Every releasable change set must update the `Unreleased` section in `UPGRADING.md` with changes, adoption steps, compatibility notes, and verification steps for agents in consuming projects. Related edits share that section. Leave version increments to `.github/workflows/release.yml`: every push to `main` automatically bumps the patch version, versions the upgrade notes, validates, commits the release files, and publishes to npm. Keep the manifest and lockfile versions aligned and include this file and `UPGRADING.md` in the package.
|
|
8
8
|
|
|
9
9
|
## Using the installed package
|
|
10
10
|
|
package/README.md
CHANGED
|
@@ -99,7 +99,7 @@ Storybook is the component catalogue and documentation surface. Stories and test
|
|
|
99
99
|
|
|
100
100
|
## Publishing
|
|
101
101
|
|
|
102
|
-
|
|
102
|
+
Merge a PR into `main` to publish a release. Every push to `main` runs [the release workflow](.github/workflows/release.yml), which installs dependencies, bumps the patch version, moves the `Unreleased` upgrade notes under that version, and runs `npm run validate`. It then commits the version files and guide back to `main` and publishes `@namroodinc/liquid-editorial` to npm under `latest`. All commands run in GitHub Actions; contributors do not run local release commands or create GitHub Releases or tags. Other branches and pull requests do not publish.
|
|
103
103
|
|
|
104
104
|
### One-time npm setup
|
|
105
105
|
|
|
@@ -119,18 +119,13 @@ npm trust github @namroodinc/liquid-editorial --repo namroodinc/liquid-editorial
|
|
|
119
119
|
|
|
120
120
|
npm requires two-factor verification for this setup. The workflow subsequently authenticates through OIDC without an `NPM_TOKEN` secret. Complete the first workflow publish within two days of adding the trusted publisher to avoid configuration expiry. See [npm's trusted publishing guide](https://docs.npmjs.com/trusted-publishers/) for the current setup requirements.
|
|
121
121
|
|
|
122
|
-
###
|
|
122
|
+
### Release a change
|
|
123
123
|
|
|
124
|
-
|
|
124
|
+
Add the change's adoption, compatibility, and verification notes under `Unreleased` in `UPGRADING.md`, then merge the PR to `main`. The workflow handles the version bump; for example, `0.1.4` becomes `0.1.5`. Pull the generated version commit before continuing local work.
|
|
125
125
|
|
|
126
|
-
|
|
127
|
-
npm version patch --no-git-tag-version
|
|
128
|
-
git add package.json package-lock.json
|
|
129
|
-
git commit -m "chore: release v0.1.1"
|
|
130
|
-
git push origin main
|
|
131
|
-
```
|
|
126
|
+
Follow **Publish to npm** in GitHub Actions to check the result. Runs are serialized, and the bot's version commit uses `GITHUB_TOKEN`, which does not trigger another workflow run.
|
|
132
127
|
|
|
133
|
-
|
|
128
|
+
Failures stop the workflow. If validation or the version push fails, npm publishing does not run. If publishing fails after the version commit is pushed, that commit stays on `main`; rerunning the workflow bumps to the next patch version. The workflow does not roll back versions or create GitHub Releases or tags.
|
|
134
129
|
|
|
135
130
|
## License
|
|
136
131
|
|
package/UPGRADING.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# Liquid Editorial upgrades
|
|
2
2
|
|
|
3
|
+
## Unreleased
|
|
4
|
+
|
|
5
|
+
## 0.1.5
|
|
6
|
+
|
|
7
|
+
### Changes
|
|
8
|
+
|
|
9
|
+
- Pushes to `main`, including merged PRs, now automatically bump the patch version and publish the package to npm after validation.
|
|
10
|
+
- The release workflow moves these notes under the new version and commits the version files and guide back to `main`.
|
|
11
|
+
|
|
12
|
+
### Adoption
|
|
13
|
+
|
|
14
|
+
Library contributors add upgrade guidance here and merge their changes to `main`. GitHub Actions handles versioning, validation, and publishing; there are no local npm release commands or manual GitHub Releases to create. Pull the generated version commit before continuing local work. Consuming applications can update the dependency as usual.
|
|
15
|
+
|
|
16
|
+
### Compatibility
|
|
17
|
+
|
|
18
|
+
The workflow publishes stable patch releases under `latest`. Creating a GitHub Release no longer triggers publishing. Component APIs are unchanged.
|
|
19
|
+
|
|
20
|
+
### Verification
|
|
21
|
+
|
|
22
|
+
Check the `Publish to npm` workflow in GitHub Actions and confirm that the new version appears on the npm package page. The workflow runs the existing full validation before committing and publishing.
|
|
23
|
+
|
|
3
24
|
## 0.1.3
|
|
4
25
|
|
|
5
26
|
### Changes
|