search

ansys / grantami-bomanalytics-openapi

Autogenerated client library for the Granta MI Compliance API
MIT License
1 stars 0 forks source link

Document proposed release procedure #35

Closed Andy-Grigg closed 2 years ago

Andy-Grigg commented 2 years ago

Closes #34

Updates the README to describe the release process for this package. It is based on the overall PyAnsys dev guide procedure, but deviates slightly because this repo is based on auto-generated code.

I have also made some additions to the repo that give it a bit of context. However, since we aren't planning on making this repo public, these notes are still just for Ansys internal reference.

This process is somewhat speculative, the workflow that it references at the end of the process doesn't currently exist.

Andy-Grigg commented 2 years ago

I think we probably want to pull some of this content out and into a separate file. This README is going to go onto pypi, and we don't really want the Contributing and Release Procedure headings in there.

Andy-Grigg commented 2 years ago

I think we probably want to pull some of this content out and into a separate file. This README is going to go onto pypi, and we don't really want the Contributing and Release Procedure headings in there.

I have since realized this README will not end up on PyPI. This README is for the repo, but the thing we will actually upload is in the ansys-grantami-bomanalytics-openapi folder, which has its own auto-generated README.