grok-digest 0.1.0 → 0.1.1

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.
Files changed (3) hide show
  1. package/README.md +10 -16
  2. package/package.json +2 -3
  3. package/CHANGELOG.md +0 -10
package/README.md CHANGED
@@ -101,27 +101,21 @@ bun run format
101
101
 
102
102
  ## Publish
103
103
 
104
- Releases are published by `.github/workflows/release.yml` when a `v<version>` tag is pushed. It refuses a tag that does not match `package.json`, runs `bun run check`, then runs `npm publish --provenance`.
104
+ Releases are cut from GitHub Actions. Open **Actions** > **Prepare Release** > **Run workflow** and choose:
105
105
 
106
- 1. Set `version` in `package.json` and write the matching entry in `CHANGELOG.md`.
107
- 2. Merge that commit to `main`.
108
- 3. Tag the merge commit and push the tag:
106
+ | Input | Meaning |
107
+ | --------- | ------------------------------------------------------------------------------ |
108
+ | `bump` | `patch`, `minor`, or `major`, applied to the version in `package.json`. |
109
+ | `version` | Optional. An exact version such as `0.2.0`, without the `v`. Overrides `bump`. |
110
+ | `dry_run` | Run every check on the new version and stop before changing Git. |
109
111
 
110
- ```sh
111
- git tag v0.1.0
112
- git push origin v0.1.0
113
- ```
112
+ `prepare-release.yml` refuses a version that is not newer, whose tag exists, or that is already on npm. It sets the new version, runs `bun run check`, commits `release: v<version>` to `main`, pushes the commit and the `v<version>` tag together, and starts `publish.yml` on that tag.
114
113
 
115
- The workflow logs in to npm with trusted publishing, so the repository holds no npm token. On npmjs.com, the package's **Settings** list `kenryu42/grok-digest` with workflow `release.yml` as a trusted publisher.
114
+ `publish.yml` checks the tag again, packs the tarball, publishes that exact tarball to npm with provenance, and creates a GitHub release with generated notes and the tarball attached. Rerunning it for a tag that is already on npm skips the publish and finishes the release.
116
115
 
117
- npm offers trusted publishing only for a package that already exists, so version 0.1.0 was published from a maintainer's machine. Provenance needs CI, so that one publish turns it off:
116
+ npm accepts the publish through trusted publishing, so the repository holds no npm token. On npmjs.com, the package's **Settings** list `kenryu42/grok-digest` with workflow `publish.yml` as a trusted publisher.
118
117
 
119
- ```sh
120
- npm login
121
- bun install --frozen-lockfile
122
- bun run check
123
- npm publish --provenance=false
124
- ```
118
+ Version 0.1.0 was published from a maintainer's machine, because npm offers trusted publishing only for a package that already exists.
125
119
 
126
120
  ## License
127
121
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "grok-digest",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Astro integration that renders a Grok Digest site: X bookmarks summarized by Grok, searchable, sorted by topic, with RSS feeds.",
5
5
  "keywords": [
6
6
  "astro",
@@ -19,8 +19,7 @@
19
19
  "grok-digest": "dist/cli.js"
20
20
  },
21
21
  "files": [
22
- "dist",
23
- "CHANGELOG.md"
22
+ "dist"
24
23
  ],
25
24
  "type": "module",
26
25
  "exports": {
package/CHANGELOG.md DELETED
@@ -1,10 +0,0 @@
1
- # Changelog
2
-
3
- ## 0.1.0
4
-
5
- First release of the `grok-digest` package.
6
-
7
- - Astro integration that serves the bookmarks page, topic feeds, favicon, and `robots.txt`.
8
- - Schema version 1, the `bookmarks.json` array existing sites already use. `SCHEMA_VERSION` is exported from `grok-digest/schema`.
9
- - `grok-digest validate` checks `bookmarks.json` and, when present, `processed.json` and `removed.json`.
10
- - `grok-digest build`, `dev`, and `preview` run the site with the Astro version the package depends on, so a site needs no Astro config. `SITE_URL` and `BASE_PATH` set Astro's `site` and `base`.