-
Couldn't load subscription status.
- Fork 41
chore: add manual backport instructions to readme #594
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -67,6 +67,36 @@ python3 ./server.py 8880 & | |
|
|
||
| Then open <http://localhost:8880> in your browser. | ||
|
|
||
| ## Backporting Manual Changes | ||
|
|
||
| In the event that a backported update is necessary, manual deployment of the newly built HTML is handled via Git tags, which are version-numbered tags based on major Lean versions matching the RegEx pattern `^v4\.\d+\.\d+$`. Pushing a new tag triggers the necessary deployment, but to do so requires first deleting any existing tag of the same name. The following describes the steps and commands you may use to manage this process. | ||
|
|
||
| Make any desired changes to the codebase. Once you have tested changes locally, create a new branch based on the version of the reference manual you are modifying. By convention, this branch should match the tag (i.e. version number), but without the leading `v`. Push this branch to the remote. | ||
|
|
||
| For example, for modifications to the reference manual associated with Lean version 4.22, the branch should be named `4.22.0`: | ||
ashandoak marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ``` | ||
| git checkout -b 4.22.0 //create new branch | ||
|
||
| git push origin 4.22.0 //push new branch to remote | ||
ashandoak marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| Any existing tag matching the desired version number must be deleted on both the remote and locally, then regeneratged locally and pushed to the remote to trigger deployment. | ||
|
|
||
| For example, for modifications to the reference manual associated with Lean version 4.22, the tag to be regenerated is `v4.22.0` and the commands to delete it are: | ||
|
|
||
| ``` | ||
| git push origin :v4.22.0 //delete remote tag | ||
| git tag --delete v4.22.0 //delete local tag | ||
ashandoak marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| Recreating the `v4.22.0` tag locally and pushing to origin will now trigger the new deployment: | ||
|
|
||
| ``` | ||
| git tag v4.22.0 //create new tag locally | ||
| git push origin v4.22.0 //push tag to remote | ||
ashandoak marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
| Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information. | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.