-
Notifications
You must be signed in to change notification settings - Fork 136
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
Site: new placeholders for nightly version, tag and unstable suffix #8939
Changes from 2 commits
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 | ||||||
---|---|---|---|---|---|---|---|---|
|
@@ -98,6 +98,10 @@ get_latest_version () { | |||||||
# located at the root-level `/docs` directory. | ||||||||
create_nightly () { | ||||||||
echo " --> create nightly" | ||||||||
local version="$(cat ../version.txt)" | ||||||||
local version_base="${version%-SNAPSHOT}" | ||||||||
echo " ... version: ${version}" | ||||||||
echo " ... version_base: ${version_base}" | ||||||||
|
||||||||
# Remove any existing 'nightly' directory and recreate it | ||||||||
rm -rf build/versions/nightly/ | ||||||||
|
@@ -108,6 +112,12 @@ create_nightly () { | |||||||
mv build/versions/nightly/docs/mkdocs.yml build/versions/nightly | ||||||||
rm build/versions/nightly/docs/index-release.md | ||||||||
|
||||||||
echo " ... replace version placeholders in versioned docs" | ||||||||
find build/versions/nightly/docs -name "*.md" -exec sed -i='' "s/::NESSIE_VERSION::/${version}/g" {} \; | ||||||||
find build/versions/nightly/docs -name "*.md" -exec sed -i='' "s/::NESSIE_VERSION_BASE::/${version_base}/g" {} \; | ||||||||
find build/versions/nightly/docs -name "*.md" -exec sed -i='' "s/::NESSIE_TAG::/latest/g" {} \; | ||||||||
find build/versions/nightly/docs -name "*.md" -exec sed -i='' "s/::NESSIE_UNSTABLE::/-unstable/g" {} \; | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
(Similar below for releases) |
||||||||
|
||||||||
cd build/versions/ | ||||||||
|
||||||||
# Update version information within the 'nightly' documentation | ||||||||
|
@@ -314,8 +324,11 @@ release() { | |||||||
echo " ... replace title in versioned mkdocs.yml" | ||||||||
sed -i'' -E "s/(^site_name:[[:space:]]+).*$/\1\"Nessie ${RELEASE_VERSION}\"/" "${target}/mkdocs.yml" | ||||||||
|
||||||||
echo " ... replace version placeholder in versioned docs" | ||||||||
find "${target}" -name "*.md" -exec sed -i "s/::NESSIE_VERSION::/${RELEASE_VERSION}/g" {} \; | ||||||||
echo " ... replace version placeholders in versioned docs" | ||||||||
find "${target}" -name "*.md" -exec sed -i='' "s/::NESSIE_VERSION::/${RELEASE_VERSION}/g" {} \; | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. According to this SO question, the syntax There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Seems to work, yes |
||||||||
find "${target}" -name "*.md" -exec sed -i='' "s/::NESSIE_VERSION_BASE::/${RELEASE_VERSION}/g" {} \; | ||||||||
find "${target}" -name "*.md" -exec sed -i='' "s/::NESSIE_TAG::/${RELEASE_VERSION}/g" {} \; | ||||||||
find "${target}" -name "*.md" -exec sed -i='' "s/::NESSIE_UNSTABLE:://g" {} \; | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
|
||||||||
echo " ... adding release to nav.yml" | ||||||||
sed -i "s/ RELEASE_PLACEHOLDER_MARKER$/ RELEASE_PLACEHOLDER_MARKER\\n - Nessie ${RELEASE_VERSION}: '\!include build\\/versions\\/${RELEASE_VERSION}\\/mkdocs.yml'/" ./nav.yml | ||||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -27,16 +27,10 @@ databases. | |||||
for production use. Any JDBC compliant database can be used, but it must be created and the | ||||||
schema initialized before running the Nessie GC tool. | ||||||
|
||||||
## Running locally | ||||||
## Running the standalone uber jar | ||||||
|
||||||
The Nessie GC tool can be downloaded from the [GitHub | ||||||
Releases](https://github.com/projectnessie/nessie/releases) page, for example: | ||||||
|
||||||
```shell | ||||||
curl -L -o nessie-gc.jar https://github.com/projectnessie/nessie/releases/download/nessie-::NESSIE_VERSION::/nessie-gc-::NESSIE_VERSION::.jar | ||||||
``` | ||||||
|
||||||
To see the available commands and options, run: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's keep this line separate. |
||||||
Check download options in the [Nessie download page](../downloads/index.md). Once you downloaded the | ||||||
jar, to see the available commands and options, run: | ||||||
|
||||||
```shell | ||||||
java -jar nessie-gc.jar --help | ||||||
|
@@ -92,7 +86,7 @@ docker run --rm -e POSTGRES_USER=pguser -e POSTGRES_PASSWORD=mysecretpassword -e | |||||
Create the database schema if required: | ||||||
|
||||||
```shell | ||||||
docker run --rm ghcr.io/projectnessie/nessie-gc:::NESSIE_VERSION:: create-sql-schema \ | ||||||
docker run --rm ghcr.io/projectnessie/nessie-gc::NESSIE_UNSTABLE:::::NESSIE_TAG:: create-sql-schema \ | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
--jdbc-url jdbc:postgresql://127.0.0.1:5432/nessie_gc \ | ||||||
--jdbc-user pguser \ | ||||||
--jdbc-password mysecretpassword | ||||||
|
@@ -101,16 +95,16 @@ docker run --rm ghcr.io/projectnessie/nessie-gc:::NESSIE_VERSION:: create-sql-sc | |||||
Now we can run the Nessie GC tool: | ||||||
|
||||||
```shell | ||||||
docker run --rm ghcr.io/projectnessie/nessie-gc:::NESSIE_VERSION:: gc \ | ||||||
docker run --rm ghcr.io/projectnessie/nessie-gc::NESSIE_UNSTABLE:::::NESSIE_TAG:: gc \ | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
--jdbc-url jdbc:postgresql://127.0.0.1:5432/nessie_gc \ | ||||||
--jdbc-user pguser \ | ||||||
--jdbc-password mysecretpassword | ||||||
``` | ||||||
|
||||||
The GC tool has a great number of options, which can be seen by running `docker run --rm | ||||||
ghcr.io/projectnessie/nessie-gc:::NESSIE_VERSION:: --help`. The main command is `gc`, which is followed by | ||||||
subcommands and options. Check the available subcommands and options by running `docker run --rm | ||||||
ghcr.io/projectnessie/nessie-gc:::NESSIE_VERSION:: gc --help`. | ||||||
ghcr.io/projectnessie/nessie-gc::NESSIE_UNSTABLE:::::NESSIE_TAG:: --help`. The main command is `gc`, | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
which is followed by subcommands and options. Check the available subcommands and options by running | ||||||
`docker run --rm ghcr.io/projectnessie/nessie-gc::NESSIE_UNSTABLE:::::NESSIE_TAG:: gc --help`. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
## Running with Kubernetes | ||||||
|
||||||
|
@@ -142,7 +136,7 @@ spec: | |||||
spec: | ||||||
containers: | ||||||
- name: nessie-gc | ||||||
image: ghcr.io/projectnessie/nessie-gc:::NESSIE_VERSION:: | ||||||
image: ghcr.io/projectnessie/nessie-gc::NESSIE_UNSTABLE:::::NESSIE_TAG:: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
args: | ||||||
- gc | ||||||
- --uri | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm - I don't see
NESSIE_VERSION_BASE
being used.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah it's "just in case"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed.