Skip to content
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

Merged
merged 3 commits into from
Jun 26, 2024

Conversation

adutra
Copy link
Contributor

@adutra adutra commented Jun 26, 2024

No description provided.

@@ -33,7 +33,7 @@ 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
curl -L -o nessie-gc.jar https://github.com/projectnessie/nessie/releases/download/nessie-::NESSIE_VERSION_BASE::/nessie-gc-::NESSIE_VERSION_BASE::.jar
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Obviously, this link will give 404. I don't think there is much we can do about it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's better to just link the GC options on the downloads page and remove the curl example

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" {} \;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to this SO question, the syntax -i='' should be portable across different OSes (just -i gives an error on macOS).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems to work, yes

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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep this line separate.

site/bin/_lib.sh Outdated
@@ -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" {} \;
Copy link
Member

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.

Copy link
Contributor Author

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"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed.

site/bin/_lib.sh Outdated
Comment on lines 118 to 119
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" {} \;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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" {} \;
find build/versions/nightly/docs -name "*.md" -exec sed -i='' "s/::NESSIE_DOCKER_SUFFIX::/-unstable:latest/g" {} \;

(Similar below for releases)

site/bin/_lib.sh Outdated
Comment on lines 330 to 331
find "${target}" -name "*.md" -exec sed -i='' "s/::NESSIE_TAG::/${RELEASE_VERSION}/g" {} \;
find "${target}" -name "*.md" -exec sed -i='' "s/::NESSIE_UNSTABLE:://g" {} \;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
find "${target}" -name "*.md" -exec sed -i='' "s/::NESSIE_TAG::/${RELEASE_VERSION}/g" {} \;
find "${target}" -name "*.md" -exec sed -i='' "s/::NESSIE_UNSTABLE:://g" {} \;
find "${target}" -name "*.md" -exec sed -i='' "s/::NESSIE_DOCKER_SUFFIX::/:${RELEASE_VERSION}/g" {} \;

@@ -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 \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
docker run --rm ghcr.io/projectnessie/nessie-gc::NESSIE_UNSTABLE:::::NESSIE_TAG:: create-sql-schema \
docker run --rm ghcr.io/projectnessie/nessie-gc::NESSIE_DOCKER_SUFFIX:: create-sql-schema \

@@ -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 \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
docker run --rm ghcr.io/projectnessie/nessie-gc::NESSIE_UNSTABLE:::::NESSIE_TAG:: gc \
docker run --rm ghcr.io/projectnessie/nessie-gc::NESSIE_DOCKER_SUFFIX:: gc \

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`,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
ghcr.io/projectnessie/nessie-gc::NESSIE_UNSTABLE:::::NESSIE_TAG:: --help`. The main command is `gc`,
ghcr.io/projectnessie/nessie-gc::NESSIE_DOCKER_SUFFIX:: --help`. The main command is `gc`,

ghcr.io/projectnessie/nessie-gc:::NESSIE_VERSION:: gc --help`.
ghcr.io/projectnessie/nessie-gc::NESSIE_UNSTABLE:::::NESSIE_TAG:: --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_UNSTABLE:::::NESSIE_TAG:: gc --help`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`docker run --rm ghcr.io/projectnessie/nessie-gc::NESSIE_UNSTABLE:::::NESSIE_TAG:: gc --help`.
`docker run --rm ghcr.io/projectnessie/nessie-gc::NESSIE_DOCKER_SUFFIX:: gc --help`.

@@ -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::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
image: ghcr.io/projectnessie/nessie-gc::NESSIE_UNSTABLE:::::NESSIE_TAG::
image: ghcr.io/projectnessie/nessie-gc::NESSIE_DOCKER_SUFFIX::

@adutra adutra merged commit 1e4030c into projectnessie:main Jun 26, 2024
18 checks passed
@adutra adutra deleted the nightly-latest branch June 26, 2024 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants