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.

Sign up for GitHub

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

Add explanation for order of actions when adding a new SDK / module #85

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add explanation for order of actions when adding a new SDK / module #85

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e1d308c
Add explanation for order of actions when adding a new SDK / module
adinauer Oct 14, 2022
5e53320
Update README.md
adinauer Nov 29, 2022
91389ef
Update README.md
adinauer Nov 29, 2022
3d99b08
Update README.md
adinauer Nov 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,20 @@ on unix platforms.

## Adding New SDKs

### Order of actions

1. update `.craft.yml` config to publish new package to your registry and GH
2. cut the release
3. update craft config to publish to release registry
4. PR to this repository to manually add published new package. See steps below.
Comment on lines +33 to +36
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The correct order is:

  1. release without the craft modules (.craft.yml)
  2. add the released version to the release registry manually
  3. add the modules to craft modules (.craft.yml)
  4. enjoy automatic releases

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, will update later

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's work in progress to make this easier / unnecessary. So let's wait with this PR.


### Pre-releases

If you plan to perform a pre-release (e.g. `alpha`, `beta`, `rc` or similar)
you do not need to add it to this repository.

### Steps

1. Create `packages/<registry>/<package_name>/<exact_version>.json` for each
version you want to register.

Expand Down