Skip to content

Commit

Permalink
Merge pull request #204 from julienrf/docs-1.x
Browse files Browse the repository at this point in the history
Set 1.0.x release series as stable in the documentation
  • Loading branch information
guy9 authored Aug 26, 2024
2 parents aa000e5 + f4a4059 commit 4e747f4
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,14 @@ Follow the procedure documented [here](https://stackoverflow.com/a/15505308/5617

## Publishing

Create a new [GitHub release](https://github.com/scylladb/scylla-migrator/releases), give it a tag name (please see below), a title, and a description, and then click Publish. A workflow will be triggered and will build the application fat-jar and upload it as a release asset.
Create a new [GitHub release](https://github.com/scylladb/scylla-migrator/releases), give it a tag name (please see below), a title, and a description, and then click Publish. A workflow will be automatically triggered and will build the application fat-jar and upload it as a release asset. Last, _fast-forward-merge_ the branch `master` into the current stable feature-branch:

~~~ sh
git checkout 1.0.x
git pull origin 1.0.x
git merge --ff-only master
git push origin 1.0.x
~~~

Rules for the release tag name:
- Make sure to use tag names like `v1.2.3`, starting with `v` and followed by a [semantic version number](https://semver.org/).
Expand Down
5 changes: 3 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,13 @@
TAGS = []
BRANCHES = [
"master",
"1.0.x"
]
# Sets the latest version.
LATEST_VERSION = "master"
LATEST_VERSION = "1.0.x"
# Set which versions are not released yet.
# Todo: List master when there is more than one version.
UNSTABLE_VERSIONS = []
UNSTABLE_VERSIONS = ["master"]
# Set which versions are deprecated
DEPRECATED_VERSIONS = [""]
# Sets custom build.
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ The following table summarizes the required version of Spark and Scala for each
Migrator Spark Scala
======== ===== ======
0.9.x 3.5.x 2.13.x
1.x 3.5.x 2.13.x
======== ===== ======

.. toctree::
Expand Down

0 comments on commit 4e747f4

Please sign in to comment.