@pager/logger
Advanced tools
Comparing version 7.7.0 to 7.7.1-fen-1084-7bpqttol.1
{ | ||
"name": "@pager/logger", | ||
"version": "7.7.0", | ||
"version": "7.7.1-fen-1084-7bpqttol.1", | ||
"description": "Logging library", | ||
@@ -18,2 +18,3 @@ "keywords": [ | ||
"build": "tsc", | ||
"lint": "tsc --noEmit && eslint . --quiet", | ||
"semantic-release": "semantic-release", | ||
@@ -52,4 +53,13 @@ "test": "NEW_RELIC_ENABLED=false lab", | ||
"release": { | ||
"extends": "@pager/semantic-release-config" | ||
"extends": "@pager/semantic-release-config", | ||
"branches": [ | ||
"master", | ||
{ | ||
"name": "!master", | ||
"prerelease": "${((name.match(/[A-Za-z]+-[0-9]+/)) ?? 'alpha') + '-' + Math.floor(Math.random() * 10**12).toString(32)}", | ||
"channel": "alpha" | ||
} | ||
], | ||
"tagFormat": "v${version}" | ||
} | ||
} |
@@ -94,1 +94,27 @@ # @pager/logger | ||
``` | ||
### Prereleases | ||
New versions are published automatically via the `package-prerelease` github workflow. If you add the `package-alpha` github label to a PR, at least one commit on your branch has a prefix that semantic-release recognizes as needing a new version (i.e., `fix` or `feat`), and your branch differs from master for at least one file in the root directory, an appropriate release will be generated and published to the `alpha` tag on NPM. | ||
Alpha versions should never be merged into master, so another workflow will prevent merge while the `package-alpha` label is present. Once you remove the label, you should be able to merge your PR. | ||
> [!NOTE] | ||
> This workflow uses [semantic-release](https://semantic-release.gitbook.io/semantic-release) which inspects commit messages to determine whether or not a new release is needed. This means if your branch contains only `chore`-prefixed commits, no release will be triggered. If you want to trigger a prerelease, you should push a commit prefixed with `package-fix`, `package-feat`, `fix`, or `feat`. | ||
> [!WARNING] | ||
> Changes made to `CHANGELOG.md` and `package.json` are not committed to git. This means the CHANGELOG.md is unmaintained, and the version in package.json is not accurate. Instead, we rely on git tags to indicate what version the SDK is at for a given commit SHA | ||
The tl;dr is that to publish an alpha, you must meet the following requirements: | ||
1. Your branch differs from master for at least one file within the root directory | ||
2. At least one commit on your branch has the appropriate format for semantic-release to recognize | ||
3. Your branch has the `package-alpha` label | ||
If these things are true, a release should be created when you add the label, as well as after pushing new commits to the remote branch. You can also add and remove the label to re-trigger the workflow. | ||
#### Troubleshooting Prereleases | ||
1. Does your branch have at least one commit with an appropriate prefix? You must have a commit with one of the default [semantic-release commit formats](https://github.com/semantic-release/semantic-release?tab=readme-ov-file#commit-message-format) that trigger a release, or one configured in our [shared semantic-release config](https://github.com/pagerinc/semantic-release-config/blob/master/.releaserc.js) | ||
2. Look at the history for the [package pre-release github workflow](https://github.com/pagerinc/edge-api-admin/actions/workflows/package-prerelease.yaml) for any errors during runs on your PR, or if the workflow is erroring for all PRs. The error messages may help reveal the problem, otherwise you can ask for help on slack in #eng-architecture |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Empty package
Supply chain riskPackage does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Environment variable access
Supply chain riskPackage accesses environment variables, which may be a sign of credential stuffing or data theft.
Found 3 instances in 1 package
120
0
7993
2
0
2
2