Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 2.47 KB

README.md

File metadata and controls

61 lines (41 loc) · 2.47 KB
Raw

build-tools

Run tests Audit dependencies (daily)

This package contains build tools required by the Open Pioneer Trails framework.

Development Notes

Running tests locally

  • Build all packages (or start their dev mode):

    # Builds all packages
$ pnpm run build  

# Or, in the package directory:
$ cd packages/...
$ pnpm dev

  • Run pnpm install to link packages (and the CLI tool used by integration tests)

  • Run pnpm test

Windows users

If you're developing the build tools on windows, you will likely have to Window's support für symbolic links. This is needed for the plugin tests: they emulate a pnpm monorepo with local links via manual symlinks.

To enable symbolic links on windows you need to enable windows developer mode (German Windows 11: Einstellungen > Datenschutz und Sicherheit > Für Entwickler > Entwicklermodus). Additionally, you need to set the following git config: git config --global core.symlinks true. If this setting was not enabled from the beginning, it might be necessary to set up the project again from scratch to avoid problems with link creation.

Releasing

This repository uses Changesets to manage versioning and publishing. When implementing a change, don't forget to add an appropriate changeset by running pnpm changeset add.

The publish workflow (see .github/workflows directory) automatically creates a prepared pull request with version updates and changelog entries derived from the changesets in the repository. To release changed packages, simply merge the pull request.

Useful local commands:

$ pnpm changeset        # Create a new changeset ("add" is optional)
$ pnpm changeset status # Show which packages would be published, verify configuration

Things to keep in mind:

  • There should currently be no pending changesets for ignored packages (ignore in .changeset/config.json). Otherwise the merged versions PR will not trigger a publish. You can prefix the file names of those changesets with "." temporarily.

License

Apache-2.0 (see LICENSE file)