feat: tag-driven release pipeline for versioned docs and spec#807
Open
zcstarr wants to merge 10 commits into
Open
feat: tag-driven release pipeline for versioned docs and spec#807zcstarr wants to merge 10 commits into
zcstarr wants to merge 10 commits into
Conversation
This change add support for retrieving and applying release notes to the broader docs interface after creating a release through the github interface. This in turn creates a PR to merge that includes md documentation that tracks the release notes. This is part 1 of 2 commits to incrementally support multiversion releases.
… spec This is the second portion of a commit to release docs. We take tagged releases and then generate release notes that are then stored in docs release so they can be viewed from the documentaiton site. We also generate a snapshot of the documents so we can support multiple versions going back in time. Finally, we add support for next, which are so we can see changes that have been added to main but have not been released yet. This will make it easy to then understand the documentation. Additionally, we must have a follow up PR that adds the release notes to the doc site, as this is cleaner than needing to publish to update the release notes everytime. This will allow for one off typo changes that don't need to go through the release process from scratch but can just be committed into mainline.
4 tasks
Contributor
Author
|
Just noting here that the PR is unsquashed for review but will be squashed and rebased for merging |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR Adds a release pipeline that snapshots versioned docs and a stamped
assembled-specbranch from a singlev*.*.*tag push.Additionally it adds running or mainline version support for all the tooling. In order to have support for this we introduce a Next version in the docs, and a separate main branch for the assembled spec. The main branch is version less, as 0.0.0 , but contains both the
refs-openrpc.jsonand theopenrpc.jsonfor downstream consumers.The following workflows are introduced to github actions. The thing to note is that once a release is tagged in order to ensure github pages tracks the latest change, the CDN page must be invalidated with the automated PR that merges in the release notes. This is an artifact of being able to track main changes into the github pages and the sha1 commit has not changing between release.
There is a way to automate it, but that introduces mainline commits by the github actions bot. This might be done in the future and would streamline the release process, but does introduce an action that pushes directly to main.
Workflows
release.yaml— tag push → build, version snapshot, Pages deploy,GitHub Release, stamped
assembled-specbranchsync-release-notes.yaml— on release published/edited, opens a PRmirroring notes into
docs-releases/(also invalidates Pages cache)publish-spec.yaml— manualassembled-specre-push for recoverydeploy.yaml— keeps rolling Pages + unstampedassembled-spec-main