Skip to content

[Proposal] Release Strategy #36

Open
@kavilla

Description

Is your feature request related to a problem?

Currently, the functional test repo consumes this NPM package via git references: https://github.com/opensearch-project/opensearch-dashboards-functional-test/blob/main/package.json#L41

It seems hit or miss if it respects the main branch or the lock file: https://github.com/opensearch-project/opensearch-dashboards-functional-test/blob/main/package-lock.json#L185. It is also confusing when developing which one is the update and if NPM will cache the reference and install.

What solution would you like?

This package is really just a dev package and it is only used for FTRepo (as of now). Being that it's not used as a software and it's for testing purposes. I do not see there being a reason to maintain multiple branches. It also isn't updated frequently.

This repo can still comply to SEMVER but avoid the operational burden of supporting older branches by cutting tags out of main.

For example:
https://github.com/opensearch-project/opensearch-dashboards-test-library/releases/tag/1.0.4

When there is a need to make a major version change then the branching strategy can be revisited or we can just patch off of tags.

What alternatives have you considered?

Default OpenSearch Project branching strategy

Do you have any additional context?

We are then able to move fast and without actually publishing an NPM package we can make the FTRepo install by release artifact instead of using git.

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions