Skip to content

Commit 0990268

Browse files
authored
Repo maintenance (#6)
* Add Initial Repo Maintenance Files. Signed-off-by: Rajvaibhav Rahane <[email protected]> * add github templates, workflows, codeowners Signed-off-by: Rajvaibhav Rahane <[email protected]> * Add RELEASING.md and .codecov.yml Signed-off-by: Rajvaibhav Rahane <[email protected]> --------- Signed-off-by: Rajvaibhav Rahane <[email protected]>
1 parent cb3032d commit 0990268

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

.codecov.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
codecov:
2+
require_ci_to_pass: yes
3+
4+
coverage:
5+
precision: 2
6+
round: down
7+
range: "70...100"
8+
status:
9+
project:
10+
default:
11+
target: 80% # the required coverage value
12+
threshold: 2% # the leniency in hitting the target
13+
14+
ignore:
15+
- '**/tests/*.py'

RELEASING.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
- [Overview](#overview)
2+
- [Branching](#branching)
3+
- [Single Repo Artifacts Branching](#single-repo-artifacts-branching)
4+
- [Feature Branches](#feature-branches)
5+
- [Versioning](#versioning)
6+
- [Version Numbers](#version-numbers)
7+
- [Remote-Vector-Index-Build-Service Version Numbers](#remote-vector-index-build-service-version-numbers)
8+
- [Tagging](#tagging)
9+
- [Release Labels](#release-labels)
10+
11+
## Overview
12+
13+
This document explains the release strategy for artifacts in the remote-vector-index-service-worker.
14+
15+
## Branching
16+
17+
Projects create a new branch when they need to start working on 2 separate versions of the product, with the `main` branch being the furthermost release.
18+
19+
### Single Repo Artifacts Branching
20+
21+
For the initial first release, remote-vector-index-build-service follows a simpler branching model with the next release always living on `main` and no patch branches.
22+
23+
### Feature Branches
24+
25+
Do not creating branches in the upstream repo, use your fork, for the exception of long lasting feature branches that require active collaboration from multiple developers. Name feature branches `feature/<thing>`. Once the work is merged to `main`, please make sure to delete the feature branch.
26+
27+
## Versioning
28+
29+
All distributions in this organization [follow SemVer](https://opensearch.org/blog/technical-post/2021/08/what-is-semver/). A user-facing breaking change can only be made in a major release. Any regression that breaks SemVer is considered a high severity bug.
30+
31+
### Version Numbers
32+
33+
#### Remote-Vector-Index-Build-Service Version Numbers
34+
35+
The build number of the service is 3-digit `major.minor.patch` (e.g. `1.9.0`)
36+
37+
### Tagging
38+
39+
Create tags after a release that match the version number, `major.minor.patch`, without a `v` prefix.
40+
41+
### Release Labels
42+
43+
Repositories create consistent release labels, such as `v1.0.0`, `v1.1.0` and `v2.0.0`. Use release labels to target an issue or a PR for a given release. See [MAINTAINERS](MAINTAINERS.md#triage-open-issues) for more information on triaging issues.

0 commit comments

Comments
 (0)