Skip to content

7903: Use local repo for version and upgrade cli - #7904

Open
ca61688 wants to merge 23 commits into
developfrom
7903-use-local-repo-for-version-and-upgrade
Open

7903: Use local repo for version and upgrade cli#7904
ca61688 wants to merge 23 commits into
developfrom
7903-use-local-repo-for-version-and-upgrade

Conversation

@ca61688

@ca61688 ca61688 commented Aug 13, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Make sure you have checked all steps below.

Issue

  • My PR fully resolves the following issues. I've referenced an issue in the PR title, for example "Issue 1234 - My
    Feature". Note that before an issue is finished, you can still make a pull request by raising a separate issue
    for your progress.

Tests

  • My PR adds the following tests based on our test strategy OR does not need testing for this extremely good reason:
    • Script change so no automated testing available
    • Been able to test manually that this change doesn't break existing functionality. However Github only has the latest build and our other repos dont current publish the cli images. This will be tested as part of Include Docker tools in pre-publishing pipeline #7614

Documentation

  • In case of new functionality, my PR adds documentation that describes how to use it, or I have linked to a
    separate issue for that below.
  • If I have added new Java code, I have added Javadoc that explains it following our conventions and style.
  • If I have added or removed any dependencies from the project, I have updated the NOTICES file.

@ca61688 ca61688 added the pr-stacked-top A stacked pull request that we don't want to merge into its target until the target PR is merged label Aug 13, 2026
@ca61688 ca61688 linked an issue Aug 13, 2026 that may be closed by this pull request
Use local repo for version and update cli in pre publish #7903
Closed
@ca61688
ca61688 marked this pull request as ready for review August 14, 2026 07:54
@ca61688
ca61688 force-pushed the 7899-retrieve-cli-script-locally-when-available branch from 67e9c94 to f0e5dc7 Compare August 14, 2026 07:55
@ca61688
ca61688 force-pushed the 7903-use-local-repo-for-version-and-upgrade branch from 762288c to 661eb33 Compare August 14, 2026 07:55
@ca61688 ca61688 added the needs-reviewer Pull requests that need a reviewer to be assigned label Aug 14, 2026
@rtjd6554
rtjd6554 force-pushed the 7899-retrieve-cli-script-locally-when-available branch from f0e5dc7 to 6081942 Compare August 14, 2026 09:45
@rtjd6554
rtjd6554 force-pushed the 7903-use-local-repo-for-version-and-upgrade branch from 661eb33 to c1dd12a Compare August 14, 2026 09:45
@ca61688
ca61688 force-pushed the 7899-retrieve-cli-script-locally-when-available branch from 6081942 to 95edad2 Compare August 18, 2026 09:41
@ca61688
ca61688 force-pushed the 7903-use-local-repo-for-version-and-upgrade branch from c1dd12a to b7a61ac Compare August 18, 2026 09:41
@rtjd6554
rtjd6554 force-pushed the 7899-retrieve-cli-script-locally-when-available branch from 95edad2 to fb38637 Compare August 19, 2026 09:14
@rtjd6554
rtjd6554 force-pushed the 7903-use-local-repo-for-version-and-upgrade branch from b7a61ac to 62bfd93 Compare August 19, 2026 09:14
@patchwork01
patchwork01 force-pushed the 7899-retrieve-cli-script-locally-when-available branch from fb38637 to 1c03b92 Compare August 21, 2026 10:16
@patchwork01
patchwork01 force-pushed the 7903-use-local-repo-for-version-and-upgrade branch from 62bfd93 to fbdc1c5 Compare August 21, 2026 10:16
patchwork01
patchwork01 requested changes Aug 21, 2026
View reviewed changes
Comment thread docs/developer-guide.md

If you have the CLI installed already it will be replaced with the version that is built. If the `runInDocker.sh` script
is different in the version you installed before, it will not be replaced. You can find it
at `$HOME/.local/bin/sleeper`, and manually overwrite it with the contents of `./scripts/cli/runInDocker.sh`.

@patchwork01 patchwork01 Aug 21, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

It looks like the explanation in this paragraph is missing now?

@ca61688 ca61688 Aug 25, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Will add something back in

Comment thread docs/developer-guide.md Outdated
./scripts/cli/install.sh
```

If you want to use a custom container registry with locally built images, pass the `--registry` flag:

@patchwork01 patchwork01 Aug 21, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I don't understand what this means, you can't use a container registry and locally built images at the same time?

Comment thread docs/developer-guide.md
and put it on the system path. Then `sleeper ...` commands will work as though you'd installed it normally.
To install the CLI from the local repository, run the install script directly. It will detect `runInDocker.sh`
alongside it and use that instead of downloading from GitHub, and will record the local repository path so that
`sleeper cli upgrade` and `sleeper cli pull-images` continue to use the local version:

@patchwork01 patchwork01 Aug 21, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Is this correct? The build scripts tag with the local image tags. The install script pulls the remote images, and then re-tags them with the local image tags.

@ca61688 ca61688 Aug 25, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I'm not sure I understand, this paragraph doesn't mention tagging at all?

Comment thread scripts/cli/install.sh
@patchwork01

patchwork01 commented Aug 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

This needs testing. #7614 is done now so it looks like it can be tested against that.

@patchwork01 patchwork01 removed the needs-reviewer Pull requests that need a reviewer to be assigned label Aug 21, 2026
@rtjd6554
rtjd6554 force-pushed the 7899-retrieve-cli-script-locally-when-available branch from 1c03b92 to 7a4c41a Compare August 21, 2026 14:41
@rtjd6554
rtjd6554 force-pushed the 7903-use-local-repo-for-version-and-upgrade branch from fbdc1c5 to 38297fa Compare August 21, 2026 14:41
@ca61688
ca61688 force-pushed the 7899-retrieve-cli-script-locally-when-available branch from 61ba51c to 7e50919 Compare August 24, 2026 09:16
@ca61688
ca61688 force-pushed the 7903-use-local-repo-for-version-and-upgrade branch from d188bca to 8bbd5a5 Compare August 24, 2026 09:16
@ca61688
ca61688 force-pushed the 7899-retrieve-cli-script-locally-when-available branch from 7e50919 to c525e60 Compare August 24, 2026 09:50
@ca61688
ca61688 force-pushed the 7903-use-local-repo-for-version-and-upgrade branch from 8bbd5a5 to 7967a7c Compare August 24, 2026 09:50
@ca61688
ca61688 force-pushed the 7899-retrieve-cli-script-locally-when-available branch from c525e60 to 7a0f903 Compare August 24, 2026 10:01
@ca61688
ca61688 force-pushed the 7903-use-local-repo-for-version-and-upgrade branch from 7967a7c to cb8d6b0 Compare August 24, 2026 10:01
ca61688 added 4 commits August 24, 2026 11:48
@ca61688
Merge branch '7899-retrieve-cli-script-locally-when-available' of git…
1e1341c 
…hub.com:gchq/sleeper into 7899-retrieve-cli-script-locally-when-available
@ca61688
Merge branch 'develop' into 7899-retrieve-cli-script-locally-when-ava…
0e2c8a3 
…ilable
@ca61688
Merge branch '7903-use-local-repo-for-version-and-upgrade' of github.…
ccd00c6 
…com:gchq/sleeper into 7903-use-local-repo-for-version-and-upgrade
@ca61688
Merge branch '7899-retrieve-cli-script-locally-when-available' into 7…
f5d6185 
…903-use-local-repo-for-version-and-upgrade
@ca61688
ca61688 changed the base branch from 7899-retrieve-cli-script-locally-when-available to develop August 24, 2026 13:27
@ca61688 ca61688 mentioned this pull request Aug 24, 2026
Closed
5 tasks
@patchwork01 patchwork01 removed the pr-stacked-top A stacked pull request that we don't want to merge into its target until the target PR is merged label Aug 24, 2026
@ca61688 ca61688 linked an issue Aug 24, 2026 that may be closed by this pull request
Adapt Docker tools for pre-publishing flow #7650
Open
@ca61688 ca61688 removed a link to an issue Aug 24, 2026
Use local repo for version and update cli in pre publish #7903
Closed
@ca61688

ca61688 commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator Author

Can be re reviewed. I've tested with a custom registry but haven't been able to test with a version other that latest That testing will need to wait for the other registry to publish versions

@ca61688 ca61688 removed their assignment Aug 25, 2026
@ca61688 ca61688 added the needs-reviewer Pull requests that need a reviewer to be assigned label Aug 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@patchwork01 patchwork01 patchwork01 requested changes
@rtjd6554 rtjd6554 rtjd6554 approved these changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

needs-reviewer Pull requests that need a reviewer to be assigned

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Adapt Docker tools for pre-publishing flow

3 participants

@ca61688 @patchwork01 @rtjd6554