Skip to content

Commit 70d8b4c

Browse files
committed
Add README file
1 parent 8a3ae21 commit 70d8b4c

File tree

3 files changed

+31
-2
lines changed

3 files changed

+31
-2
lines changed

.changeset/angry-rules-build.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@g-tests/changeset-tests": patch
3+
---
4+
5+
Add README file

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## @changesets/cli Github action.
2+
3+
### Standard public package template.
4+
5+
#### @see [Publish](https://github.com/9a8ri3L/changeset-tests/blob/main/.github/workflows/publish.yml)
6+
7+
- Make sure that the [NPM_TOKEN](https://docs.npmjs.com/creating-and-viewing-access-tokens) is not expired.
8+
- Make sure that "Allow GitHub Actions to create and approve pull requests" is checked.
9+
- Make sure that [package.json](https://github.com/9a8ri3L/changeset-tests/blob/main/package.json) file has `"publishConfig": {
10+
"access": "public"
11+
}`, and remove `"private": "false"` if present.
12+
- Make sure that [.changeset/config.json](https://github.com/9a8ri3L/changeset-tests/blob/main/.changeset/config.json) file has `"access": "public"`
13+
- Make sure that the installed version of your package manager is the same in [.github/workflows YML files](https://github.com/9a8ri3L/changeset-tests/tree/main/.github/workflows) with the used version in your local.
14+
- Run `pnpm changeset` every time you need to update your package version, before commiting and pushing to Github repository and [changesets/action](https://github.com/changesets/action) will handle version.
15+
- Every PR is opened by `Chengesets release Github action` will create a head branch `changeset-release/main`, which can be deleted automatically after merge by activate "Automatically delete head branches" in the repo general settings.
16+
- Every mergrd PR has been opened by `Changesets release Github action` will create a tag/release/publish to [NPM registry](https://www.npmjs.com/)
17+
18+
@see [changeset-tests NPM package](https://www.npmjs.com/package/@g-tests/changeset-tests)
19+
20+
That's a standard configuration.
21+
For more information, visit [Changesets](https://github.com/changesets/changesets)

package.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,11 @@
1717
"release": "pnpm run build && changeset publish"
1818
},
1919
"keywords": [],
20-
"author": "",
21-
"license": "ISC",
20+
"author": "Gabriel",
21+
"license": "MIT",
22+
"repository": "https://github.com/9a8ri3L/changeset-tests",
23+
"homepage": "https://github.com/9a8ri3L/changeset-tests#readme",
24+
"bugs": "https://github.com/9a8ri3L/changeset-tests/issues",
2225
"devDependencies": {
2326
"@changesets/cli": "^2.27.1",
2427
"tsup": "^8.0.2",

0 commit comments

Comments
 (0)