Skip to content

Commit 70c48c6

Browse files
Add readme for release process and versioning strategy
1 parent ed575c3 commit 70c48c6

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# python-static-analysis
2+
3+
This repo generates a docker container containing the Static analysis tools that Springload uses
4+
5+
## Releases
6+
7+
To generate a new container version, add a git tag to a specific commit, and push that tag to the repo
8+
9+
Github actions will then build this container and attach tags for the major, minor and full version tags (ie, 2.1.3 would be tagged 2, 2.1 and 2.1.3)
10+
11+
## Versioning strategy
12+
13+
We are working with a [Semantic Versioning](https://semver.org/) strategy for releases on this container.
14+
15+
Practically this means that a *patch* version will for be anything backwards compatible, including adding a new tool.
16+
17+
A minor version is.... not very useful in this context, but could be a change to a tool, small package upgrades, or compatible base-container change.
18+
19+
A major version is **anything** that would change the formatting of previously acceptable code.
20+
21+
As such, we recommend pinning consuming repos to the *major*.

0 commit comments

Comments
 (0)