You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 025d862
Browse filesBrowse the repository at this point in the historyBrowse files
Create a new branch based on master (i.e. v0.22-branch) and push to the main Feast repo. This will be where
115
-
cherry-picks go for future patch releases and where documentation will point.
113
+
#### 4a: Versioned branch and documentation publication
114
+
115
+
The `publish_versioned_docs` release job creates the `v<major>.<minor>-branch` maintenance branch
116
+
at the released tag, imports that branch into a versioned GitBook space, and makes the new space
117
+
the public default. It verifies the final GitBook state before succeeding.
118
+
119
+
The repository must define `GITBOOK_ORG_ID` and `GITBOOK_SITE_ID` variables and a scoped
120
+
`GITBOOK_TOKEN` secret with permission to create and update spaces, update the site, and publish
121
+
it. The release token must be able to create the maintenance branch.
122
+
123
+
The job is safe to rerun. It reuses matching branches and spaces, but it will not move an existing
124
+
maintenance branch that points somewhere other than the released tag. It also leaves the previous
125
+
documentation version as the public default until the new branch has imported successfully.
116
126
117
127
#### 4b: Adding a high level summary in the GitHub release notes
118
128
By default, Semantic Release will pull in messages from commits (features vs fixes, etc). But this is hard to digest,
119
129
so it helps to have a high level overview. See https://github.com/feast-dev/feast/releases for the releases.
120
130
121
131
#### 4c: Update documentation
122
132
123
-
In the Feast Gitbook:
133
+
If the automated documentation job fails, use its error as the recovery point and complete the
134
+
remaining steps in the Feast GitBook:
135
+
124
136
1. Create a new space within the Feast collection
125
137
2. Go to the overflow menu on the top -> Synchronize with Git
0 commit comments