# Skynet SDK Publishing
###### tags: `SDK`

Instructions for publishing new versions of the SDKs.

## Notes

### Expectations

1. New **major versions** are released for breaking changes.
2. **New tags** for the version are pushed to GitHub (double check on each repo's *tags* page).

## Release Checklist

1. [ ] Publish and check tags on GitHub.
2. [ ] Update docs.
3. [ ] Update skynet-webportal SDK examples, if necessary.

## skynet-js

**Who's responsible:** Karol / Marcin

1. Test:
1. Run test-skapp MySky tests
2. Try test-skapp large file uploads
2. Update changelog
3. Update version in package.json
4. Commit and set version tag in git
5. `npm login` (if needed)
6. `npm publish`
7. Update `skynet-webportal`

### Publishing to the beta stream

This is mostly the same as above, except:

1. Make sure the version ends in `-beta`.
2. Publish with `npm publish --tag beta`.

## nodejs

**Who's responsible:** PJ / Marcin

1. Update changelog
2. Update version in package.json
3. Set version tag in git)
4. `npm login`
5. `npm publish`

## python

**Who's responsible:** PJ / Marcin

0. `rm -R dist/` if it exists.
1. Update changelog
2. Update version in setup.py
3. Commit and set version tag in git
4. `pip install twine`
5. `python setup.py sdist bdist_wheel`
6. Double-check contents of distribution packages: `tar tzf dist/siaskynet-<version>.tar.gz`
7. `twine check dist/*`
8. `twine upload dist/*` (use username `__token__` and the API token as the password)

Detailed instructions [here](https://realpython.com/pypi-publish-python-package/).

## go

**Who's responsible:** Anyone

1. Update changelog
2. If changing major version, update `go.mod`
3. Set version tag in git
4. Raise and merge PR
5. Update skynet-cli to use the new version if necessary.

## skynet-cli

**Who's responsible:** Anyone

1. Update to use newest go-skynet: `go get -u github.com/NebulousLabs/go-skynet/<version>`
2. Update docs: `make doc`
3. Update changelog
4. Update version variable in `skynet/main.go`
5. Set version tag in git
6. Raise and merge PR
7. Run Docker. Run `cd ./release-scripts` and `./build-in-docker.sh <branch> <version>`
8. Add generated release binaries and SHA256SUMS file to GitHub as a new release.
9. Update `Formula/skynet-cli.rb` with the new version and SHA hash.
1. Download source code `.tar.gz`.
2. Run `openssl sha256 < ./skynet-cli-<version>.tar.gz`
3. Fill this value in the `sha256` field.

## skynet-docs

**Who's responsible:** Anyone

The SDK docs support **multiple versions**. Each new major version has its own separately-viewable and linkable documentation.

The latest major version should be accessible at either https://nebulouslabs.github.io/skynet-docs/ or `https://nebulouslabs.github.io/skynet-docs/<latest version>`.

Older major versions should still be accessible at `https://nebulouslabs.github.io/skynet-docs/<old version>`.

To achieve this, we use subfolders within the `source/` directory named after each major version, e.g. `source/v2`. These subfolders have their own `index.html` and `includes/` directories. Edits should be done after reading the instructions below.

The `index.html` of each version should point to all other versions. People reading old docs should be able to tell that there are newer docs available.

### Updating the current version

1. Perform edits on `source/includes/` and `source/index.html`.
2. Copy these files into `source/<latest version>/`.
3. Raise a PR.
4. Once merged, a team member will run `deploy.sh`.

### Adding a new major version

0. Update the `VERSION` variable in `pre-commit` in the root repo directory.
1. Create a folder for the new version: `source/<latest version>`.
2. Make the desired changes in `source/includes` and `source/index.html.md`.
3. Overwrite `source/includes/_updating.md`. This should call out any breaking changes that would force skapp developers to update their code.
4. Copy the files into the new version folder created in step 1. Running `pre-commit` does this for you.
5. Update every `index.html` in the repo to point to the new version. Make sure the sidebars in `index.html` indicate that this is an old version.
6. Follow steps 3-4 in the "Updating the current version" section above.

## See Also

- [Skynet Docs](https://siasky.net/docs/#introduction)
- [Status of Skynet SDKs](/BFPWYyDfT6yalz0o_gipyw?both)
- [Skynet SDK Testing](/dHSts01AR4WnnOmvZOcRxw)