-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: ADR sdk package release + docs generation in MD #120
Conversation
3e9b319
to
b7378c1
Compare
@antonbaliasnikov @amagyar-iohk Hello fam, please check this ADR for better handling release candidates. It drafts the different posibilities we have and the preferred choice which I checked against semantic-release configuration. The ADR can be approved when considered, but i'd say we are really intereated on all the benefits it brings, lets try to do it the earliest possible to start the year properly! |
306b72b
to
0e49193
Compare
docs: ADR sdk package release Signed-off-by: Francisco Javier Ribó Labrador <elribonazo@gmail.com>
37ace71
to
3f28060
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@elribonazo @curtis-h overall it looks good. I have only few questions
From what I understood, we'll have master
and rc
channels (+ maintenance ones)
During the development everything will be merged to master
(except changes in maintenance channels) and when we want to test/prepare for a release, we merge from master
to rc
?
And if it is good, we release from the master
branch?
A commit in maintenance or RC branches will create RC or Beta packages, once those changes are ready, we will merge the changes from RC branches to master and when this happens a production release will happen and the package will be published to master. So not really, we don't be pushing everything to master. All goes into the rc branches instead and you move from there to master when we have a production release and not an RC. Still deployment is manual, no issues there. |
fix: Update documentation on docs/sdk
@amagyar-iohk more things have slightly changed here. The documentation side is being integrated in the main Atala docs website. The Action to generate docs is removed from push + tags, we rely on semantic-release package to push the documentation changes on each release we make. This will integrate very nicely with what we are aiming to have, RC branches, etc. Docs simply generate on each release no matter which one, thats all. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for the clarifications
Co-authored-by: Francisco Javier Ribó Labrador <elribonazo@gmail.com> Signed-off-by: Francisco Javier Ribó Labrador <elribonazo@gmail.com>
Description
This PR is adding ADR template and our first ADR to change the release process, contents are detailed in the DRAFT ADR.
Together with this ADR, we are removing the HTML documentation portal generation and deployment to github pages.
Instead, this PR will merge the docs into docs/sdk on each release.
The documentation portal will then grab this auto-generated md files and deploy them to the main website when needed.
Changes:
ADR - open for comment
Jira link
https://input-output.atlassian.net/browse/ATL-6147
Checklist