Skip to content

Commit aec7ffa

Browse files
readme update
1 parent ae605b6 commit aec7ffa

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,20 @@ The generated Python relies upon the [RunePythonRuntime](https://github.com/fino
1212

1313
The features of the current version can be found in the [release notes](./RELEASE.md)
1414

15+
## Releases
16+
17+
Releases are made automatically by invoking the [release workflow](./.github/workflows.yml). Releases will be sequentially tagged using four semantic elements (x.y.z.n). Each change of the value of rosetta.dsl.version in the POM resets the fourth digit.
18+
19+
For example, if the dsl version is 9.64.1, the release will be tagged 9.64.1.0. Until a new dsl version, each subsequent release will increment the fourth digit (i.e. the next release would be tagged 9.64.1.1).
20+
21+
Releases should not be manually tagged.
22+
23+
### Rune-DSL Updates
24+
25+
Renovate will generate a PR when the version of the DSL has been updated at com.regnosys.rosetta:com.regnosys.rosetta. The PR will clarify whether the change succsessfully builds and passes JUNIT and Python unit testing. Any maintainer can merge changes that successfully build and pass the tests.
26+
27+
A PR must be raised for changes to address address build or testing failures.
28+
1529
## Repository Organization
1630

1731
- `README.md` - this file, for documentation purposes
@@ -20,7 +34,7 @@ The features of the current version can be found in the [release notes](./RELEAS
2034
- `src/main` - Java/Xtend code to generate Python from Rune
2135
- `src/test` - Java/Xtend code to run JUnit tests on the code generation process
2236
- `build` - configuration scripts to setup and tear down the Python unit testing environment
23-
- `build/build_cdm.sh` - used to create a Python package from code generated using CDM Rune definitions
37+
- `build/build_cdm.sh` - used to create a Python package using CDM Rune definitions
2438
- `test` - Python unit tests and scripts to run the tests
2539

2640
## Development setup
@@ -87,14 +101,6 @@ To use a different version of CDM, update CDM_VERSION in the script.
87101

88102
The Roadmap will be aligned to the [Rune-DSL](https://github.com/finos/rune-dsl/) and [CDM](https://github.com/finos/common-domain-model/blob/master/ROADMAP.md) roadmaps.
89103

90-
### Rune-DSL Updates
91-
92-
Renovate will generate a PR when the version of the DSL has been updated at com.regnosys.rosetta:com.regnosys.rosetta. The PR will clarify whether the change succsessfully builds and passes JUNIT and Python unit testing.
93-
94-
Any maintainer can merge changes that successfully build and pass the tests.
95-
96-
Build or testing failures should be escalated to [@plamen-neykov](https://github.com/plamen-neykov) or [@dschwartznyc](https://github.com/dschwartznyc) for remediation.
97-
98104
## Contributing
99105

100106
For any questions, bugs or feature requests please open an [issue](https://github.com/finos/rune-python-generator/issues)

0 commit comments

Comments
 (0)