Skip to content

Commit

Permalink
Revise package scope and publish config with instructions
Browse files Browse the repository at this point in the history
publish instructions:

`atlas packages permission grant -u {{staffid}}`
`yarn preconstruct build`
`cd packages/cli/`
`npm version {{version}}`
`npm publish`
  • Loading branch information
Tim Keir committed Sep 24, 2024
1 parent 2034c99 commit ccc6e68
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 5 deletions.
16 changes: 16 additions & 0 deletions PUBLISHING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
### Publishing a new copy of our fork

Note that for versioning we should retain the original OSS version and add a suffix for any customisations we make.

* If you've just pulled in downstream changes then you'd publish a new suffixed version e.g. if the OSS version is `0.21.4` then we'd use `0.21.4-1`.
* If you've made a new customisation then increment the suffixed version e.g. if the current version is `0.21.4-1` then you'd use `0.21.4-2` next.

To publish this Atlassian fork run the following commands:

1. `atlas packages permission grant -u {{staffid}}` to grant publishing writes within Artifactory
2. `yarn preconstruct build` to generate the dist
3. `cd packages/cli/` to navigate into the CLI workspace
4. `npm version {{version}}` to increment the version
5. `npm publish` to upload to artifactory
6. Discard the git diff generated for `yarn.lock` and `package-lock.json`.
7. Commit the updated version number within `packages/cli/package.json`.
13 changes: 8 additions & 5 deletions packages/cli/package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
{
"name": "@manypkg/cli",
"version": "0.21.4",
"name": "@atlassian/manypkg-cli",
"version": "0.21.4-2",
"repository": {
"type": "git",
"url": "https://github.com/Thinkmill/manypkg.git",
"url": "https://github.com/atlassian-forks/manypkg",
"directory": "packages/cli"
},
"license": "MIT",
"main": "dist/manypkg-cli.cjs.js",
"module": "dist/manypkg-cli.esm.js",
"publishConfig": {
"registry": "https://packages.atlassian.com/api/npm/atlassian-npm/"
},
"main": "dist/atlassian-manypkg-cli.cjs.js",
"module": "dist/atlassian-manypkg-cli.esm.js",
"bin": {
"manypkg": "./bin.js"
},
Expand Down

0 comments on commit ccc6e68

Please sign in to comment.