Skip to content

Commit 431dc08

Browse files
authored
chore: add some further docs (#100)
1 parent 61c44a6 commit 431dc08

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ The version will be used as the "tag" for the policy such as `ghcr.io/updatecli/
3333

3434
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.
3535

36-
## How to test this locally
36+
## How to test this?
37+
38+
### locally
3739

3840
A specific policy under the `updatecli` folder:
3941

@@ -54,3 +56,10 @@ RELEASEPOST_GITHUB_TOKEN=$(gh auth token) \
5456
GITHUB_WORKSPACE=$(pwd) \
5557
make e2e-test
5658
```
59+
60+
### CI
61+
62+
You can run https://github.com/elastic/oblt-updatecli-policies/actions/workflows/e2e.yml through the
63+
UI.
64+
65+
However, it's recommended to close all the open PRs related to the e2e that were already open.

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ This repository contains a list of common Updatecli published on `ghcr.io/elasti
44

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

7+
## Contributing
8+
9+
See the [contributing documentation](CONTRIBUTING.md).
10+
711
## HOWTO
812

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

1519
**Publish**
1620

17-
Each policy defined in this repository is automatically published on ghcr.io via a GitHub Action workflow
21+
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.
1822

1923
**Show**
2024

@@ -43,3 +47,9 @@ policies:
4347
```
4448
4549
More information about Updatecli compose feature can be found [here](https://www.updatecli.io/docs/core/compose).
50+
51+
**Enrol a new Repository**
52+
53+
If you want to use the Observability Updatecli policies in a new GitHub repository, you need to
54+
grant `read` access to the specific policy, this is a private GitHub repository hence a private
55+
`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).

0 commit comments

Comments
 (0)