rethinkdb / rethinkdb_rebirth

The open-source database for the realtime web.
https://rethinkdb.com
Other
1k stars 42 forks source link

Fix packaging, rebrand cosmetically and update README #22

Closed floydkots closed 6 years ago

floydkots commented 6 years ago

Description

Packaging #17

  1. Changed maintainer details
  2. Changed package and directory names
  3. Set up travis to run tests in both VM and docker containers and then build the packages and deploy them to bintray. Starting with support for the xenial and trusty versions of Ubuntu. Added docker containers into the mix to allow for greater variety in the test environments and packaging. Travis only provides the precise and trusty version of ubuntu on it's VMs.
  4. Used RebirthDB's keys to sign the packages on bintray.
    Known Issues
  5. The ClusteringRaft.FailOver test case fails nondeterministically. At least that's how it looks to me. I can't as yet tell why that happens.
  6. The displayed total count of steps during the packaging process is inaccurate.
  7. Other linux distros are not yet supported. Their support will be added gradually. I thought it important that you first have a look of the changes so far.
  8. The whole testing to deployment process takes longer.

Rebranding #14

  1. Besides the package and directory names, also changed the service, server executable name and commands from rethinkdb ... to rebirthdb ...
  2. Left behind a trail of modified license headers where appropriate.
    Known Issues
  3. Deeper messages from errors and logs, and on the UI may still show rethinkdb. I lean more on the side of piecemeal modifications, as we observe the effects.

Updating the README #8

  1. Went for hopefully more relevant and sensical contents on the README.
  2. Added a Sponsors section, currently featuring AIDAX and DigitalOcean.
    Known Issues
  3. The README features our drivers, some of which are yet to be updated to reflect our change in naming.
  4. The README also doesn't link to our documentation site. That will be updated when our site comes up.

Overally, I think the above steps are in the right direction, but I would like to hear what you guys think before we go for deeper changes.

Also, I'll totally appreciate every help and advice with the known and unknown issues.

Finally, I've left the long commit history, if it might be of any help in contextualizing the changes. I hope that the changes, if approved, will be squashed before being merged.

floydkots commented 6 years ago

Just realized the build scripts are unable to login to docker because the credentials are unavailable to it:

Similarly, we do not provide these values to untrusted builds, triggered by pull requests from another repository.

Quoting https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-settings. Needless to say, the build succeeds in my fork.

So, how can I go about this? Should I create a packaging branch under rebirthdb, open a pull request and merge to it so that I finally open the pull request from a 'trusted build'? I'm not even sure if it would work.

As for codacy:

  1. It recommends adding a MAINTAINER field, but the docs say MAINTAINER is deprecated in favor of LABEL, so I used LABEL.
  2. It is also unhappy about having both wget and curl in the same dockerfile. However, rebirthdb's build system and scripts need both.
  3. It recommends pinning the apt-get packages to specific versions. Well, I don't know, should we?
floydkots commented 6 years ago

Closing this PR in favour of #24.