Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Docs: Add release process doc #26

Merged
merged 3 commits into from
May 30, 2022
Merged

Conversation

matej-g
Copy link
Contributor

@matej-g matej-g commented May 30, 2022

Signed-off-by: Matej Gera matejgera@gmail.com

We've been talking and preparing the initial release with @saswatamcode and we wanted to codify the process for the future.

The aims I'm following with the release processes are:

  1. It should reflect the state of project, i.e. we're in the initial stage where we iterate often in tight loops and have small number of users and contributors. The release should therefore be easy and straightforward.
  2. We should be able to rely on main branch and tag our releases simply to main branch, instead of creating new branches.
  3. We should not need release candidate with the current state of project. RC for the initial release is an exception.

Signed-off-by: Matej Gera <matejgera@gmail.com>
Copy link
Member

@saswatamcode saswatamcode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! LGTM!

Minor nit.

docs/release.md Outdated
@@ -0,0 +1,14 @@
# Release process

We use semantic versioning for `obstctl` in format `vX.Y.Z`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We use semantic versioning for `obstctl` in format `vX.Y.Z`.
We use semantic versioning for `obsctl` in format `vX.Y.Z`.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Funnily enough, 'obst' means 'fruit' in German 🍌 🍎 🍇, but we cannot control fruits with CLI (yet).

Signed-off-by: Matej Gera <matejgera@gmail.com>
docs/release.md Outdated Show resolved Hide resolved
Copy link
Member

@squat squat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small nit, otherwise LGTM

Co-authored-by: Lucas Servén Marín <lserven@gmail.com>
@matej-g matej-g merged commit b517748 into observatorium:main May 30, 2022
Copy link
Member

@bwplotka bwplotka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏽

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants