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.

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

Suggested changes for CI and release automation #463

Open
wants to merge 3 commits into
base: wjh/streamline-release
Choose a base branch
from

Conversation

colincasey
Copy link
Contributor

@colincasey colincasey commented Oct 4, 2024

Splits the npm scripts into primary development tasks and lifecycle scripts:

  • build
  • lint: Checks for any lint errors
  • prepack: Lifecycle script to guarantee compiled files are up-to-date before publishing
  • prepare-pr: Runs tests & rebuilds all generated files which is useful to do before opening a PR so no CI validations fail
  • test
  • version: Lifecycle script to guarantee all files affected by a version bump are regenerated and added to git

All other scripts are prefixed with _ to distinguish between the high-level development tasks above and smaller tasks that can be used as building blocks.

Also included in this PR:

  • extracted the inline script that would check if any generated files had not been committed to validate-generated-files.sh

Splits the npm scripts into primary development tasks and lifecycle scripts:
- `build`
- `precommit`: Rebuilds all generated files
- `prepack`: Lifecycle script to guarantee compiled files are up-to-date before publishing
- `test`
- `version`: Lifecycle script to guarantee all files affected by a version bump are regenerated and added to git

All other scripts are prefixed with `_` to distinguish between the high-level development tasks above and smaller tasks that can be used as building blocks.

Also included in this PR:
- extracted the inline script that would check if any generated files had not been committed to `validate-generated-files.sh`
Splits the npm scripts into primary development tasks and lifecycle scripts:
- `build`
- `precommit`: Rebuilds all generated files
- `prepack`: Lifecycle script to guarantee compiled files are up-to-date before publishing
- `test`
- `version`: Lifecycle script to guarantee all files affected by a version bump are regenerated and added to git

All other scripts are prefixed with `_` to distinguish between the high-level development tasks above and smaller tasks that can be used as building blocks.

Also included in this PR:
- extracted the inline script that would check if any generated files had not been committed to `validate-generated-files.sh`
package.json Outdated Show resolved Hide resolved
package.json Show resolved Hide resolved
package.json Show resolved Hide resolved
.github/workflows/publish.yaml Show resolved Hide resolved
package.json Show resolved Hide resolved
@colincasey colincasey requested a review from wjhsf October 8, 2024 14:36
Splits the npm scripts into primary development tasks and lifecycle scripts:
- `build`
- `precommit`: Rebuilds all generated files
- `prepack`: Lifecycle script to guarantee compiled files are up-to-date before publishing
- `test`
- `version`: Lifecycle script to guarantee all files affected by a version bump are regenerated and added to git

All other scripts are prefixed with `_` to distinguish between the high-level development tasks above and smaller tasks that can be used as building blocks.

Also included in this PR:
- extracted the inline script that would check if any generated files had not been committed to `validate-generated-files.sh`
@colincasey
Copy link
Contributor Author

@wjhsf @awaterma I've setup a granular automation token in npm to be here used as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants