Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: issue with prepack command that blocks release #252

Merged
merged 3 commits into from
Mar 10, 2022
Merged

fix: issue with prepack command that blocks release #252

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
74c8f76
fix: issue with prepack command in gh action
Souvikns Mar 9, 2022
2cf4ad3
Update package.json
Souvikns Mar 9, 2022
eefad04
Update package.json
Souvikns Mar 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@
"lint": "eslint --max-warnings 0 --config .eslintrc .",
"lint:fix": "eslint --max-warnings 5 --config .eslintrc . --fix",
"postpack": "rimraf oclif.manifest.json",
"prepack": "rimraf lib && tsc -b && oclif manifest && oclif readme",
"prepack": "npm run build && oclif manifest && oclif readme",
"prepublishOnly": "npm run build",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need this if we build it in prepack stage?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah since we are building in prepublish stage which is run before prepack we don't need this. Though we are also running oclif readme in version so we might now need that too

cli/package.json

Line 140 in 9fecc14

"version": "oclif readme && git add README.md",

also I think this is why the TOC is not working

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

imho:

  • we should only have prepublishOnly that runs: npm run build && oclif manifest
  • version script is not needed, can be removed, same prepack. Same with readme script I guess
  • oclif readme should be added to generate:assets. Although I do not really know what oclif readme is actually doing 😆 But if it is doing some important update to readme, it should be in generate:assets script. This workflow will make sure readme is updated in GH repo. We can also run generate:assets in prepublishOnly script if we need also some magic updates in readme to show up in NPM package readme view

makes sense?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have removed oclif readme. It creates documentation which is handled here #123

"pretest": "npm run build",
"pretest:coverage": "npm run build",
Expand Down