Skip to content

Commit

Permalink
docs: Update readme adding release process (#1003)
Browse files Browse the repository at this point in the history
* docs: Update readme adding release process

* chore: Update package-lock
  • Loading branch information
cyaiox authored Oct 10, 2024
1 parent 0c4dc9b commit c201492
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,24 @@ Use the Decentraland Software Development Kit v7 to create experiences for the D
## Repository guide

This repository consists of the following components, packaged for the `nodejs`/`npm` ecosystem (find them under the respective subfolder in `packages`):

* `@dcl/react-ecs`: a framework to create scenes using the [React](https://reactjs.org) framework
* `@dcl/sdk`: contains all the packages that a scene needs to work.
* `@dcl/ecs`: an engine used to render things on screen
* `@dcl/sdk-commands`: contains the command line interface
* `@dcl/inspector`: Editor interface.

And some internal or maybe useful packages if you're digging deeper into how the Decentraland runtime works:
* `@dcl/js-runtime`: the `js-runtime` contains the typings for the environment variables available in the sandboxed execution environment for scenes
* `@dcl/playground-assets`: contains the files needed by the playground. https://playground.decentraland.org/

* `@dcl/js-runtime`: the `js-runtime` contains the typings for the environment variables available in the sandboxed execution environment for scenes
* `@dcl/playground-assets`: contains the files needed by the playground. <https://playground.decentraland.org/>

### Versioning notes

When `@dcl/sdk` is built, as it depends on new versions of `@dcl/ecs`, these are built first and `@dcl/sdk` includes the new versions.

### ECS 6 dev support

The ECS 6 lives in the `6.x.x` branch, there will no longer be new features but it's available for fixes or patches.
With a PR to `6.x.x`, you can test the build with the S3 publish, but it'll be necessary to create a release for propagating under `decentraland-ecs@latest`.

Expand All @@ -37,7 +39,12 @@ We use golden files to create snapshots for a series of test scenes. Most change

To re-create these golden files, run `make build update-snapshots`. In some cases, this will generate some discrepancies with the clean environment used by the continuous integration we use (CircleCI). If you run into this issue, please run `make deep-clean-and-snapshot` to invalidate all cached calculations. **Be careful**: it will clean all local changes on your git [working tree](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefworkingtreeaworkingtree).

### Release a new SDK Version

After merging a PR to the main branch, we should wait until the [actions](https://github.com/decentraland/js-sdk-toolchain/actions/workflows/ci.yml) finish the process.

Once the actions completed successfuly, we have to create a new [Release](https://github.com/decentraland/js-sdk-toolchain/releases/new) from the main branch following this [version guideline](https://docs.decentraland.org/creator/releases/version-agreement/).

## Copyright info

This repository is protected with a standard Apache 2 license. See the terms and conditions in the LICENSE file.

8 changes: 4 additions & 4 deletions packages/@dcl/sdk-commands/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c201492

Please sign in to comment.