Skip to content

Implement Version Policy#120

Merged
singhalkarun merged 1 commit intoSamagra-Development:masterfrom
PiyushRaj927:add_versioning_policy
Feb 5, 2024
Merged

Implement Version Policy#120
singhalkarun merged 1 commit intoSamagra-Development:masterfrom
PiyushRaj927:add_versioning_policy

Conversation

@PiyushRaj927
Copy link
Collaborator

@PiyushRaj927 PiyushRaj927 commented Jan 8, 2024 •
edited
Loading

Changes

  1. Pinned TimescaleDB version to 2.13.0.

  2. Introduced PRE_RELEASE:

    • Prevents pushing the latest tag for Docker images of pre-release versions.
    • PRE_RELEASE is determined based on the current tag at the HEAD of the git tree. For instance, if the tag at HEAD is 2.0-alpha, the latest-pg15 image tag won't be pushed to the image registry.

  3. Updated Docker tag format:

    • If a tag 2.0.0 is present at HEAD, the format is 2.0.0-pg15.
    • If no tag is present, it's set as dev-pg15.

  4. Changelog Management:

    • Added CHANGELOG.md to track major changes.

  5. Updated release workflow:

    • Now uses the TimescaleDB version specified in the makefile instead of the main branch when input ts_version is empty.

Test

Tested workflow on my fork: https://github.com/PiyushRaj927/WarpSQL/actions/runs/7450274263 Docker images at https://hub.docker.com/u/d3bug77.

@PiyushRaj927 PiyushRaj927 force-pushed the add_versioning_policy branch from fb345b9 to 997a8d4 Compare January 8, 2024 10:25
@PiyushRaj927 PiyushRaj927 marked this pull request as ready for review January 8, 2024 12:39
@PiyushRaj927 PiyushRaj927 force-pushed the add_versioning_policy branch 2 times, most recently from e098694 to b855e44 Compare January 8, 2024 16:23
@PiyushRaj927
Copy link
Collaborator Author

PiyushRaj927 commented Jan 18, 2024

Fixes #119

@singhalkarun
Copy link
Collaborator

singhalkarun commented Jan 29, 2024 •
edited
Loading

  • Automatically sets PRE_RELEASE based on the current tag at the HEADof the git tree.

Can you detail this more, add examples?

  • If no tag is present, it's set as dev-pg15.

Instead of making it dev-pg15, how about we have something like last commit id because the image will get lost out on a new commit?

  • Documentations on Workflows

Also, can we create a doc which explains how the workflow works in detail so that a someone exploring repository for first time also have a clear understanding how images get built.

@PiyushRaj927
Implement Version Policy
8268f02 
- Introduce changelog
- Update workflow configurations
- Pin TimescaleDB version
- Modify MAKEFILE to manage Warpsql versioning, prerelease, and generate
Docker image tags

Signed-off-by: Piyush Raj <piyushraj92739@gmail.com>
@PiyushRaj927 PiyushRaj927 force-pushed the add_versioning_policy branch from b855e44 to 8268f02 Compare January 31, 2024 06:25
@PiyushRaj927
Copy link
Collaborator Author

PiyushRaj927 commented Jan 31, 2024

  • Automatically sets PRE_RELEASE based on the current tag at the HEADof the git tree.

Can you detail this more, add examples?

I have updated the description to be more clear and added an example

  • If no tag is present, it's set as dev-pg15.

Instead of making it dev-pg15, how about we have something like last commit id because the image will get lost out on a new commit?

sure, Makefile are updated to tag the images as per the format dev-<HEAD SHA>-pg<version>

  • Documentations on Workflows

Also, can we create a doc which explains how the workflow works in detail so that a someone exploring repository for first time also have a clear understanding how images get built.

I don't believe it's necessary to detail the specifics of the workflow since they're quite straightforward, and the image building and publishing logic is abstracted in Makefiles. Can you point out what parts of our current workflow setup that might pose challenges or appear opaque to newcomers? I'll try to make them clearer in the document.

@singhalkarun singhalkarun merged commit 7344e6a into Samagra-Development:master Feb 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@PiyushRaj927 @singhalkarun