Skip to content
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

Merged
merged 2 commits into from
Jan 3, 2024

Conversation

curtis-h
Copy link
Contributor

@curtis-h curtis-h commented Nov 10, 2023

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:

  • Creating folder for holding ADRs
  • first ADR considering how we release the SDK.
  • Generate docs in docs/sdk with md files.
  • Releasing a new version of docs on each release + commit using semantic release.

ADR - open for comment

Jira link

https://input-output.atlassian.net/browse/ATL-6147

Checklist

  • Self-reviewed the diff
  • New code has inline documentation
  • New code has proper comments/tests
  • Any changes not covered by tests have been tested manually

Copy link

github-actions bot commented Jan 2, 2024

Lines Statements Branches Functions
Coverage: 60%
60.3% (1200/1990) 48.62% (512/1053) 62.36% (353/566)

JUnit

Tests Skipped Failures Errors Time
326 2 💤 0 ❌ 0 🔥 37.581s ⏱️

@curtis-h curtis-h marked this pull request as ready for review January 2, 2024 10:48
@elribonazo
Copy link
Contributor

@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!

docs: ADR sdk package release
Signed-off-by: Francisco Javier Ribó Labrador <elribonazo@gmail.com>
Copy link
Contributor

@amagyar-iohk amagyar-iohk left a 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?

@elribonazo
Copy link
Contributor

elribonazo commented Jan 3, 2024

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.

@elribonazo
Copy link
Contributor

@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.
Needed on this PR, until its approved + merged the following PR is blocked: hyperledger/identus-docs#70

@elribonazo elribonazo changed the title docs: ADR sdk package release docs: ADR sdk package release + docs generation in MD Jan 3, 2024
Copy link
Contributor

@amagyar-iohk amagyar-iohk left a 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

@elribonazo elribonazo merged commit fd76d0a into master Jan 3, 2024
4 checks passed
@elribonazo elribonazo deleted the docs/ATL-6147 branch January 3, 2024 14:59
mixmix pushed a commit to mixmix/atala-prism-wallet-sdk-ts that referenced this pull request May 6, 2024
Co-authored-by: Francisco Javier Ribó Labrador <elribonazo@gmail.com>
Signed-off-by: Francisco Javier Ribó Labrador <elribonazo@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants