Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Document / Improve publication processes #9

Open
slifty opened this issue Jun 29, 2020 · 1 comment
Open

Document / Improve publication processes #9

slifty opened this issue Jun 29, 2020 · 1 comment
Labels
devops help us make is possible to make things documentation Improvements or additions to documentation

Comments

@slifty
Copy link
Member

slifty commented Jun 29, 2020

Task

Description

We have a few issues that came up from publishing recently, and since we hope to move other repositories to have published packages, this is a meta issue.

  1. We published a major version of base-interfaces with a mistake, which forced TWO major version releases in the span of 30 minutes. That' no good.

  2. We recently learned that we were missing a build step in our publishing processes, which meant that version 1.1.0 of base-constants did not actually include the new features in the published package.

We are going to make mistakes, so really this is a problem with our process.

  • First: I would like us to have processes around publishing release candidates / beta / alpha versions for any breaking changes.

  • Second: since we're in a period of rapid development, and we accidentally skipped past the 0.*.* versioning that SemVer allocated exactly for rapid development, I would urge us to put ANY major change into a beta / pre-release with the intent that we'll "live" on the pre-release until our APIs are locked in / we get past the fluid stage.

  • Third: We should document our release processes, this can / should be done in the meta repo; I'm comfortable with either a wiki or a committed RELEASE.md file. We should make an issue to capture this request.

  • Fourth: We should look into improving our automation, especially in monorepos. We ditched lerna (which I think is good) but now publishing is a manual and therefore error prone process. I'm uncomfortable with it all!

Relevant Resources / Research

Related Issues

None.

@slifty slifty added devops help us make is possible to make things documentation Improvements or additions to documentation labels Jun 29, 2020
@slifty
Copy link
Member Author

slifty commented Jul 12, 2020

This issue has some more information about our current publishing steps: tvkitchen/base#11

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
devops help us make is possible to make things documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant