Sprint: Orbit #1 Release Process

[flyingzumwalt]

Updated by @haadcode after original posting

Objective:

Make Orbit easily downloadable and accessible.

Goals:

• We'll focus on fixing the remaining issues with pubsub and improve orbit's correctness.
• We'll make the Electron app easily downloadable and document how to make releases.
• We'll make Orbit available at https://orbit.chat and document how to deploy a new release.
• We'll move Orbit and orbit-db repos to orbitdb organization (github.com/orbitdb)

Stretch Goals:

• We'll define integration tests for Test Lab.

We'll try to reach this goal if we have time at the end of the sprint. Given the re-allocation of people for this sprint, we might not have the time. If we don't reach this goal in this sprint, @haadcode will work on this during the next sprint, before the Test Lab sprint.

Tasks:

• Finish js-ipfs-api pubsub and use it in Orbit
  • Tracking issue: https://github.com/haadcode/orbit-db/issues/184
  • Pubsub API PR feat(pubsub): Add pubsub api ipfs-inactive/js-ipfs-http-client#493
  • Update the pubsub component in orbit (orbit-db-pubsub) use to use the current pubsub API
• Make Orbit Electron App available for download from dist.ipfs.io
  • Tracking issue: Orbit Electron App builds should be publicly available orbitdb-archive/orbit#132
  • Document how to make Orbit Electron App builds
  • Document how to make dist.ipfs.io releases
  • Release new dist.ipfs.io page with Orbit download links
• Make Orbit Web App available for use at https://orbit.chat
  • Tracking issue: Orbit should be usable at https://orbit.chat orbitdb-archive/orbit#225
  • Document orbit-web release process
  • Document the deployment process to orbit.chat
• Immutable ipfs-log
  • Tracking issue: https://github.com/haadcode/ipfs-log/issues/97
  • Merge "Immutable ipfs-log" https://github.com/haadcode/ipfs-log/pull/100
  • Make orbit-db use immutable ipfs-log: https://github.com/haadcode/orbit-db/pull/185
• Move repos to orbitdb organization
  • Tracking issue: Can orbit-db be run in the browser? orbitdb/orbitdb#1
  • Reorganize haadcode/orbit code base: Reorganize this code base orbitdb-archive/orbit#223
• Add orbit, orbit-db, ipfs-log tests to js-ipfs(-api) release process
  • Tracking in: Add orbit tests to js-ipfs release js-ipfs#747

Additional Tasks:

• Identify and define integrations tests
  • Tracking issue: Identify and define integrations tests orbitdb-archive/orbit#224
  • Enumerate a list of tests that Orbit should run in Test Lab
  • We'll work on these tasks if we have complete the main goals

[haadcode]

We've had some reshuffling on who's working on this sprint. We'll have to re-scope the content of the sprint as it's going to be just me and @RichardLitt in this sprint. We'll have a planning meeting today and see what we can commit to.

My current thinking is we'll focus on the correctness related task and the release process. We should also work on moving the repos under https://github.com/orbitdb which includes finally splitting the orbit* repos appropriately.

Add orbit, orbit-db, ipfs-log tests to js-ipfs(-api)
orbit-db and ipfs-log tests should be run as part of CI tests

@diasdavid and @dignifiedquire I know you're gonna be super busy in your upcoming sprints, but would you be able to fit ^ on your todo list? Or perhaps provide a detailed instructions on how to do approach it?

[daviddias]

I don't believe adding to CI to be always run will be good (our poor CI already takes so long) and it will be a cat and mouse game because then we have to be updating as you go (and when to update what)

I do believe though that it should be part of the release process as we did -- ipfs/js-ipfs#712 -- it just needs to be formalized.

[dignifiedquire]

Maybe we can work together with @victorbjelkholm and @Kubuxu to make sure we can run these tests as part of our new CI setup?

[haadcode]

I do believe though that it should be part of the release process as we did -- ipfs/js-ipfs#712 -- it just needs to be formalized.

I'm ok either way. @RichardLitt or me will open an issue in js-ipfs this week to follow up on this.

[haadcode]

I've update the original issue to reflect the plan for this sprint, see #345 (comment).

@RichardLitt see the TODO I left you for opening an issue to track adding orbit tests to the js-ipfs release process as per our discussion yesterday (and the comments above).

[haadcode]

I've updated the Orbit's board at https://waffle.io/haadcode/orbit. You'll see the planned goals in the "Backlog" column and the ones "In Progress" are currently being actively worked on. There are additional cards in both that are random bugs etc. to be verified to be fixed as we go.

[RichardLitt]

Opened.

[daviddias]

Sprint has happened. Closing this issue.