Skip to content

docs: Generate API documentation for release branch #2035

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

Merged
merged 3 commits into from
Oct 3, 2023

Conversation

dplewis
Copy link
Member

@dplewis dplewis commented Sep 28, 2023

Pull Request

Issue

Currently there is no permanent link to the documentation for the latest api. There is release version specific links but those can get stale as new releases are publish. This can be mitigated if parse-community/minami#1 is released

Closes: #2034

Approach

Adds support for links that match the latest release.

Example: https://parseplatform.org/Parse-SDK-JS/api/release/Parse.html#.initialize

Task

Waiting for parse-community/minami#3 to be merged and released to test.

@parse-github-assistant
Copy link

Thanks for opening this pull request!

@dplewis dplewis requested a review from mtrezza September 28, 2023 23:04
@codecov
Copy link

codecov bot commented Sep 28, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (64e6653) 100.00% compared to head (79bde21) 100.00%.
Report is 2 commits behind head on alpha.

❗ Current head 79bde21 differs from pull request most recent head 164df86. Consider uploading reports for the commit 164df86 to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##             alpha     #2035   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           61        61           
  Lines         6168      6168           
  Branches      1498      1498           
=========================================
  Hits          6168      6168           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@mtrezza mtrezza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good; is this ready for merge?

@dplewis
Copy link
Member Author

dplewis commented Oct 3, 2023

This is ready for merge

@mtrezza mtrezza changed the title docs: Generate api documentation for release branch docs: Generate API documentation for release branch Oct 3, 2023
@mtrezza mtrezza merged commit c6a3966 into parse-community:alpha Oct 3, 2023
@dplewis dplewis deleted the release-docs branch October 3, 2023 18:43
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 4.3.0-alpha.2

@parseplatformorg parseplatformorg added the state:released-alpha Released as alpha version label Oct 3, 2023
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 4.3.1-beta.1

@parseplatformorg parseplatformorg added the state:released-beta Released as beta version label Nov 16, 2023
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 4.3.1

@parseplatformorg parseplatformorg added the state:released Released as stable version label Nov 18, 2023
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 4.3.1-alpha.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
state:released Released as stable version state:released-alpha Released as alpha version state:released-beta Released as beta version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API Reference Documentation not updated
3 participants