Skip to content

Commit

Permalink
chore(docs): remove release instructions from contrib (#8955)
Browse files Browse the repository at this point in the history
Description: We no longer make releases this way, and it is also
confusing for community folks to see these instructions when they are
not applicable to them.
  • Loading branch information
joshua-goldstein authored Aug 18, 2023
1 parent 434e022 commit 2dda90a
Showing 1 changed file with 0 additions and 45 deletions.
45 changes: 0 additions & 45 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,51 +171,6 @@ Run `go test` in the root folder.
ok github.com/dgraph-io/badger/table 0.478s
ok github.com/dgraph-io/badger/y 0.004s

## Doing a release

* Create a branch called `release/v<x.y.z>` from main. For e.g. `release/v1.0.5`. Look at the
diff between the last release and main and make sure that `CHANGELOG.md` has all the changes
that went in. Also make sure that any new features/changes are added to the docs under
`wiki/content` to the relevant section.
* Test any new features or bugfixes and then tag the final commit on the release branch like:

```sh
git tag -s -a v1.0.5
```

* Push the release branch and the tagged commit.

```sh
git push origin release/v<x.y.z>
git push origin v<x.y.z>
```

* Travis CI would run the `contrib/nightly/upload.sh` script when a new tag is pushed. This script
would create the binaries for `linux`, `darwin` and `windows` and also upload them to Github after
creating a new draft release. It would also publish a new docker image for the new release as well
as update the docker image with tag `latest` and upload them to docker hub.

* Checkout the `main` branch and merge the tag to it and push it.

```sh
git checkout main
git merge v<x.y.z>
git push origin main
```

* Once the draft release is published on Github by Travis, modify it to add the release notes. The release
notes would mostly be the same as changes for the current version in `CHANGELOG.md`. Finally publish the
release and announce to users on [Discourse](https://discuss.dgraph.io).

* To make sure that docs are added for the newly released version, add the version to
`wiki/scripts/build.sh`. It is also important for a release branch for the version to exist,
otherwise docs won't be built and published for it. SSH into the server serving the docs and pull
the latest version of `wiki/scripts/build.sh` from main branch and rerun it so that it can start
publishing docs for the latest version.

* If any bugs were fixed with regards to query language or in the server then it is a good idea to
deploy the latest version on `play.dgraph.io`.

## Contributing

### Guidelines
Expand Down

0 comments on commit 2dda90a

Please sign in to comment.