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

Version Number #2

Closed
iajrz opened this issue Jan 24, 2022 · 11 comments
Closed

Version Number #2

iajrz opened this issue Jan 24, 2022 · 11 comments
Assignees
Labels
core Core infrastructure - protocol related
Milestone

Comments

@iajrz
Copy link
Contributor

iajrz commented Jan 24, 2022

Versions should be semver 2 compatible, which is aligned with golang's module versioning guidelines.

I think we should start work with version "0.99.0" to begin with, which is a number that points towards v1, is below 1.x (denoting "in development"), and is far enough from v0's version number to differentiate it.

@luyzdeleon
Copy link
Contributor

I would like to propose the use of build metadata outlined in Semver 2, so that we can have continous merging into the code while on the "same version".

@iajrz iajrz closed this as completed Feb 4, 2022
@iajrz
Copy link
Contributor Author

iajrz commented Feb 4, 2022

Ah, I noticed a misread in the specification which caused a flawed implementation, so this shouldn't be closed after all.

Format will be edited to conform to the format -- applied to our case, version number will look something like this:
Major.Minor.Patch-branch.commit.dirty+race

@iajrz iajrz reopened this Feb 4, 2022
@iajrz
Copy link
Contributor Author

iajrz commented Feb 4, 2022

In fact, the branch and commit don't quite fit into this scheme; the proper format should be Major.Minor.Patch[-dirty]+branch.commit.race, otherwise the branch name and commit hash would be used to determine precedence, and they shouldn't.

@luyzdeleon
Copy link
Contributor

What would be the actionable here @iajrz ? Creating a PR ammending the docs?

@iajrz iajrz added this to the Wiring milestone Mar 2, 2022
@iajrz
Copy link
Contributor Author

iajrz commented Mar 2, 2022

Action items:

  • addition to mage.go to make it use tag information when available.
  • Amending docs to explain what we actually do with versioning with the magefile.

@Olshansk Olshansk added the core Core infrastructure - protocol related label Apr 12, 2022
@Olshansk
Copy link
Member

Olshansk commented Jun 9, 2022

@iajrz I want to create a tag & release for main https://github.com/pokt-network/pocket as a milestone finish line.

Following the instructions in https://github.com/pokt-network/pocket/tree/main/docs/build, what should it be?

@iajrz
Copy link
Contributor Author

iajrz commented Jun 10, 2022

Tag v0.0.1-alpha.01 is a good starting point; I think the build doc needs updating.

@Olshansk
Copy link
Member

Per https://en.wikipedia.org/wiki/Software_release_life_cycle, I'll go with pre-alpha for now, but otherwise sounds good.

@Olshansk
Copy link
Member

PR with documentation update here: https://github.com/pokt-network/pocket/pull/91/files

@Olshansk
Copy link
Member

Olshansk commented Jul 1, 2022

Going to close this out given the previous version update.

@Olshansk Olshansk closed this as completed Jul 1, 2022
Olshansk added a commit that referenced this issue Aug 11, 2022
… (#159)

## Description
Minor code cleanup and footprint reduction post the first major telemetry milestone in #135.

## Type of change
Please mark the options that are relevant.

- [ ] New feature (non-breaking change which adds functionality)
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation
- [X] Other: Code cleanup

## How Has This Been Tested?

I did a docker wipe to start on a clean slate.

- [X] `make test_all`
- [X] [LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md)

## Checklist
- [X] I have performed a self-review of my own code
- [X] I have commented my code, particularly in hard-to-understand areas
- [X] I have tested my changes using the available tooling
- [X] If applicable, I have made corresponding changes to related or global README
- [X] If applicable, I have added added new diagrams using [mermaid.js](https://mermaid-js.github.io)
- [X] If applicable, I have added tests that prove my fix is effective or that my feature works
@okdas okdas mentioned this issue Oct 11, 2022
16 tasks
@KOSASIH KOSASIH mentioned this issue Jun 18, 2023
20 tasks
@0xBigBoss 0xBigBoss mentioned this issue Jul 29, 2023
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Core infrastructure - protocol related
Projects
Status: Done
Development

No branches or pull requests

4 participants