Skip to content

chore: add some further docs #100

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.

Sign up for GitHub

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

Merged
v1v merged 1 commit into from
Jul 24, 2025
Merged

chore: add some further docs #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ The version will be used as the "tag" for the policy such as `ghcr.io/updatecli/

Any change to the policy code must be reflected by a new version. Policies are automatically published on `ghcr.io` if the version is updated.

## How to test this locally
## How to test this?

### locally

A specific policy under the `updatecli` folder:

Expand All @@ -54,3 +56,10 @@ RELEASEPOST_GITHUB_TOKEN=$(gh auth token) \
GITHUB_WORKSPACE=$(pwd) \
make e2e-test
```

### CI

You can run https://github.com/elastic/oblt-updatecli-policies/actions/workflows/e2e.yml through the
UI.

However, it's recommended to close all the open PRs related to the e2e that were already open.
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ This repository contains a list of common Updatecli published on `ghcr.io/elasti

**NOTE**: Used some bits and pieces from https://github.com/updatecli/policies

## Contributing

See the [contributing documentation](CONTRIBUTING.md).

## HOWTO

**Login**
Expand All @@ -14,7 +18,7 @@ Even though all Updatecli policies published on `ghcr.io` are meant to be public

**Publish**

Each policy defined in this repository is automatically published on ghcr.io via a GitHub Action workflow
Each policy defined in this repository is automatically published on [ghcr.io](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) via a GitHub Action workflow.

**Show**

Expand Down Expand Up @@ -43,3 +47,9 @@ policies:
```

More information about Updatecli compose feature can be found [here](https://www.updatecli.io/docs/core/compose).

**Enrol a new Repository**

If you want to use the Observability Updatecli policies in a new GitHub repository, you need to
grant `read` access to the specific policy, this is a private GitHub repository hence a private
`ghcr.io`. Those steps are explained in the official [docs](https://docs.github.com/en/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package).