-
Notifications
You must be signed in to change notification settings - Fork 539
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
fb4df28
commit 9f37712
Showing
3 changed files
with
29 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -69,7 +69,6 @@ docs | |
|
||
#lerna | ||
.changelog | ||
package.json.lerna_backup | ||
|
||
# OS generated files | ||
.DS_Store | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -96,7 +96,7 @@ Please also see [GitHub workflow](https://github.com/open-telemetry/community/bl | |
|
||
- [NPM](https://npmjs.com) | ||
- [TypeScript](https://www.typescriptlang.org/) | ||
- [lerna](https://github.com/lerna/lerna) to manage dependencies, compilations, and links between packages. Most lerna commands should be run by calling the provided npm scripts. | ||
- [nx](https://github.com/nrwl/nx) to manage dependencies, compilations, and links between packages. Most nx commands should be run by calling the provided npm scripts. | ||
- [npm workspaces](https://docs.npmjs.com/cli/v10/using-npm/workspaces) | ||
- [MochaJS](https://mochajs.org/) for tests | ||
- [eslint](https://eslint.org/) | ||
|
@@ -119,6 +119,29 @@ Some tests depend on other packages to be installed, so these steps are also req | |
|
||
Each of these commands can also be run in individual packages, as long as the initial install and compile are done first in the root directory. | ||
|
||
If you're going to work on a single package and want to quickly jump into its development you can make use of the `focus` script. This scritp will run | ||
the necessary tasks to have only that package ready for development saving time. FOr example if you want to work with `@opentelemetry/resource-detector-aws` | ||
run the following command in the root folder | ||
|
||
```sh | ||
npm run focus @opentelemetry/resource-detector-aws | ||
|
||
> [email protected] focus | ||
> nx run-many -t compile -p @opentelemetry/resource-detector-aws | ||
|
||
|
||
✔ nx run @opentelemetry/instrumentation-fs:version:update (796ms) | ||
✔ nx run @opentelemetry/contrib-test-utils:compile (3s) | ||
✔ nx run @opentelemetry/instrumentation-fs:compile (3s) | ||
✔ nx run @opentelemetry/resource-detector-aws:compile (3s) | ||
|
||
——————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————————— | ||
|
||
> NX Successfully ran target compile for project @opentelemetry/resource-detector-aws and 3 tasks it depends on (7s) | ||
``` | ||
|
||
Once the command is done you can `cd` into the package and start using the ussual commands. | ||
|
||
### CHANGELOG | ||
|
||
The conventional commit type (in PR title) is very important to automatically bump versions on release. For instance: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters