@gooddata/maql-antlr4ts 0.7.1 → 0.7.2-58cc7118.0
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/README.md +29 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -85,31 +85,48 @@ Use [yalc](https://github.com/wclr/yalc) to link the package to other repositori
|
|
|
85
85
|
|
|
86
86
|
## Publishing
|
|
87
87
|
|
|
88
|
-
|
|
88
|
+
The package is published by two GitHub workflows, both run manually (`workflow_dispatch`):
|
|
89
89
|
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
90
|
+
| workflow | version published | npm dist-tag |
|
|
91
|
+
| -------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ------------ |
|
|
92
|
+
| [publish-npm-maql-antlr4ts-prerelease](https://github.com/gooddata/gdc-nas/actions/workflows/publish-npm-maql-antlr4ts-prerelease.yml) | `<package.json version>-<commit sha>.0`, for example `0.7.1-a5e4f136.0` | `prerelease` |
|
|
93
|
+
| [publish-npm-maql-antlr4ts-stable](https://github.com/gooddata/gdc-nas/actions/workflows/publish-npm-maql-antlr4ts-stable.yml) | `<package.json version>` as is, for example `0.7.1` | `latest` |
|
|
93
94
|
|
|
94
|
-
|
|
95
|
-
|
|
95
|
+
Neither workflow commits a version back. The version comes from `version` in `package.json`, so to publish a new
|
|
96
|
+
stable version, or to raise the base version of prereleases, change it in a PR first.
|
|
97
|
+
|
|
98
|
+
Both workflows refuse to publish a version that already exists on npm. For the stable workflow this means `version`
|
|
99
|
+
in `package.json` was not bumped since the last stable release. For the prerelease workflow it means the same commit
|
|
100
|
+
was already published as a prerelease.
|
|
101
|
+
|
|
102
|
+
To install a prerelease, pin its exact version, or install `@gooddata/maql-antlr4ts@prerelease`. The `latest`
|
|
103
|
+
dist-tag only moves on stable releases.
|
|
104
|
+
|
|
105
|
+
The workflows publish to npm with [trusted publishing](https://docs.npmjs.com/trusted-publishers) (OIDC), so they do not need an npm token.
|
|
106
|
+
Trusted publishing does not support self-hosted runners, so the workflows run on GitHub-hosted runners.
|
|
96
107
|
|
|
97
108
|
### Trusted publisher setup
|
|
98
109
|
|
|
99
|
-
|
|
100
|
-
|
|
110
|
+
A trusted publisher on npm is bound to a workflow file name, so each workflow needs its own entry.
|
|
111
|
+
npm supports [multiple trusted publishing configurations](https://github.blog/changelog/2026-09-03-multiple-trusted-publishing-configurations-for-npm) per package.
|
|
112
|
+
If you rename a workflow file, add an entry for the new name and remove the old one.
|
|
113
|
+
This section records how the entries were set up, so that you can change them or set them up again.
|
|
101
114
|
|
|
102
|
-
You can set
|
|
115
|
+
You can set them up in one of these ways:
|
|
103
116
|
|
|
104
117
|
- **In the npm UI** at https://www.npmjs.com/package/@gooddata/maql-antlr4ts/access.
|
|
105
|
-
- **With the npm CLI.** Use npm 11.
|
|
118
|
+
- **With the npm CLI.** Use npm 11.15.0 or newer, which has the `npm trust` command.
|
|
106
119
|
Log in to npm (`npm login`) as user `gooddata-ci`.
|
|
107
120
|
The user must have publish access to `@gooddata/maql-antlr4ts` and two-factor authentication.
|
|
108
|
-
Then run:
|
|
121
|
+
Then run, once per workflow:
|
|
109
122
|
|
|
110
123
|
```sh
|
|
111
124
|
npm trust github @gooddata/maql-antlr4ts \
|
|
112
|
-
--file
|
|
125
|
+
--file publish-npm-maql-antlr4ts-prerelease.yml \
|
|
126
|
+
--repo gooddata/gdc-nas \
|
|
127
|
+
--allow-publish
|
|
128
|
+
npm trust github @gooddata/maql-antlr4ts \
|
|
129
|
+
--file publish-npm-maql-antlr4ts-stable.yml \
|
|
113
130
|
--repo gooddata/gdc-nas \
|
|
114
131
|
--allow-publish
|
|
115
132
|
```
|