Skip to content

Commit 7f7da4e

Browse files
authored
Update README with deprecation notice
Added deprecation notice for v1 and v2 branches and updated version information.
1 parent 10ff75f commit 7f7da4e

1 file changed

Lines changed: 33 additions & 2 deletions

File tree

README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
* [Usage](#usage)
44
* [Workflow](#workflow)
5+
* [Deprecation](#deprecation)
56
* [License](#license)
67

78
## Usage
@@ -10,7 +11,7 @@ Install Updatecli for GitHub Action
1011

1112
**Options**
1213

13-
- `version`: Specify the Updatecli version to install. Accepted values are any valid releases such as `v0.86.1`.
14+
- `version`: Specify the Updatecli version to install. Accepted values are any valid releases such as `v0.118.0`.
1415

1516
- `version-file`: The path to a file containing updatecli version. Supported file types are `.updatecli-version` and `.tool-versions`. See more details in [about version-file](#Updatecli-version-file).
1617

@@ -51,7 +52,7 @@ jobs:
5152
uses: actions/checkout@v2
5253

5354
- name: Install Updatecli in the runner
54-
uses: updatecli/updatecli-action@v2
55+
uses: updatecli/updatecli-action@main
5556

5657
- name: Run Updatecli in Dry Run mode
5758
run: updatecli diff
@@ -66,6 +67,36 @@ jobs:
6667
6768
WARNING: Dont enable --debug mode in Github Action as it may leak information.
6869
70+
## Deprecation
71+
72+
> [!IMPORTANT]
73+
> The branch v1 and v2 are deprecated and will be remove soon.
74+
> You should use GitHub action version instead (or track the main branch if you really want to).
75+
> You can migrate to the latest GitHub action version using the following Updatecli policy:
76+
77+
.updatecli-compose.yaml
78+
```
79+
# export UPDATECLI_GITHUB_TOKEN=<insert PAT>
80+
# export UPDATECLI_GITHUB_USERNAME=<insert username>
81+
# updatecli compose diff --file updatecli-compose.yaml
82+
# updatecli compose apply --file updatecli-compose.yaml
83+
84+
valuesinline:
85+
scm:
86+
enabled: true
87+
kind: githubsearch
88+
search: |
89+
org:<replace with your GitHub organization>
90+
archived:false
91+
branch: "^main$|^master$" # branch accept regular expression
92+
email: <email associatedi with the git commits>
93+
limit: 0 # zero means no repository limit
94+
95+
policies:
96+
- name: Update Updatecli GitHub action version
97+
policy: ghcr.io/updatecli/policies/updatecli/githubaction:0.8.1
98+
```
99+
69100
## License
70101
71102
MIT. See `LICENSE` for more details.

0 commit comments

Comments
 (0)