You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 30, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: hacks/README.md
+19-20
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,8 @@
2
2
3
3
These scripts simplify builds, deployments or development.
4
4
5
-
## update-facet-lib
6
-
Can be executed right after `facet-lib` release to update it's version in
5
+
## update-assisted-ui-lib
6
+
Can be executed right after `assisted-ui-lib` release to update it's version in
7
7
- the facet application
8
8
- the uhc-portal (OCM)
9
9
@@ -17,7 +17,7 @@ Recently not used.
17
17
## patch-react-scripts.sh
18
18
Called from the yarn's `postinstall` phase to watch changes under `node_modules` within `yarn start`.
19
19
20
-
With this change, the `facet-lib` can be updated on-the-fly during development.
20
+
With this change, the `openshift-assisted-ui-lib` dependency can be updated on-the-fly during development.
21
21
22
22
## ocm-deployed-version.sh
23
23
Used by QE to check recent version deployed in the staging environment.
@@ -28,52 +28,51 @@ Used to create a virtual machine from an ISO (like a discovery iso), tested in o
28
28
See comments inside the script for further details.
29
29
30
30
# The Release Process
31
-
Please note, the `facet` application features heavily depend on the `facet-lib` JavaSript library which needs to be released along the `facet` application.
31
+
Please note, the `facet` application features heavily depend on the `openshift-assisted-ui-lib` JavaSript library which needs to be released along the `facet` application.
32
32
33
33
Recently release versions of both project are alligned to simplify testing.
34
34
35
35
## Prerequisities
36
36
- Have [uhc-portal](https://gitlab.cee.redhat.com/service/uhc-portal) fork
37
37
- Local username (`whoami`) is equal to the gitlab's username
38
-
- if not, use `GITLAB_USER=` env variable when calling `update-facet-lib.sh` script bellow
39
-
- Privileges to write to `facet` master - for tags and `facet-lib` version update
38
+
- if not, use `GITLAB_USER=` env variable when calling `update-assisted-ui-lib.sh` script bellow
40
39
## Steps
41
40
42
41
When releasing new version, following steps are executed:
-**Release**[facet-lib via GitHub](https://github.com/mareklibra/facet-lib/releases/new)
46
+
-**Release**[openshift-assisted-ui-lib via GitHub](https://github.com/openshift-assisted/assisted-ui-lib/releases/new)
48
47
-**Be careful** when providing following input
49
48
- Tag version in format:
50
49
- v1.4.8 or v1.4.8-1 ; notice the letter `v` prefixing the version
51
50
- Release title:
52
51
- use the same as the tag
53
52
- Description:
54
53
- Unless automated in the future, copy&paste all PR titles since last release.
55
-
- To do so, use this [sorted list of closed PRs](https://github.com/mareklibra/facet-lib/pulls?q=is%3Apr+is%3Aclosed+sort%3Aupdated-desc)
56
-
-*Note:* As a consequence, a GitHub action is trigerred on new tag created to build the library, publish to npmjs.com and generate a PR in the `facet-lib`
57
-
-*Note:* It is recommended to use GitHub web to compose a release to keep track of changes. However, the GitHub action doing majority of the work is trigerred by a new tag only.
58
-
-**Close/re-open**[a generated PR in the facet-lib](https://github.com/mareklibra/facet-lib/pulls) which is increasing project's version.
59
-
-**Approve this PR and merge a.s.a.p.** to avoid other PRs slipping in
54
+
- To do so, use this [sorted list of closed PRs](https://github.com/openshift-assisted/assisted-ui-lib/pulls?q=is%3Apr+is%3Aclosed+sort%3Aupdated-desc)
55
+
-*Note:* As a consequence, a GitHub action is trigerred on new tag created to build the library, publish to npmjs.com and generate a PR in the `assisted-ui-lib`
56
+
-*Note:* It is recommended to use GitHub web to compose a release to keep track of changes. However, the GitHub action doing majority of the work can be trigerred by a new tag only.
57
+
-**Close/re-open**[a generated PR in the assisted-ui-lib](https://github.com/openshift-assisted/assisted-ui-lib/pulls) which is increasing project's version.
58
+
-**Approve this PR and merge A.S.A.P.** to avoid other PRs slipping in
60
59
-*Note:* It is a GitHub's feature that an action can not trigger execution of another action. So without close/reopen the CI will not be executed on this PR.
61
-
-**Wait till** new `facet-lib` version is automatically published to [npmjs.com](https://www.npmjs.com/package/facet-lib)
60
+
-**Wait till** new `openshift-assisted-ui-lib` version is automatically published to [npmjs.com](https://www.npmjs.com/package/openshift-assisted-ui-lib)
62
61
63
-
-**Update**`facet-lib` in the `facet` and `uhc-portal`
62
+
-**Update**`openshift-assisted-ui-lib` in the `facet` and `uhc-portal` via
64
63
-```
65
-
$ curl https://raw.githubusercontent.com/openshift-metal3/facet/master/hacks/update-facet-lib.sh | sh -
64
+
$ curl https://raw.githubusercontent.com/openshift-metal3/facet/master/hacks/update-assisted-ui-lib.sh | sh -
66
65
```
67
-
- Watch output of the script. It might happen in rare cases that new `facet-lib` version is not automatically found (i.e. due to short delay), so you can force it by:
66
+
- Watch output of the script. It might happen in rare cases that new `openshift-assisted-ui-lib` version is not automatically found (i.e. due to short delay), so you can force it by:
68
67
```
69
-
$ curl https://raw.githubusercontent.com/openshift-metal3/facet/master/hacks/update-facet-lib.sh | FACET_LIB_VERSION=1.4.8 sh -
68
+
$ curl https://raw.githubusercontent.com/openshift-metal3/facet/master/hacks/update-assisted-ui-lib.sh | ASSISTED_UI_LIB_VERSION=1.5.0 sh -
70
69
```
71
70
- New browser tabs are opened, **finish the process** there by:
72
-
- merge `facet-lib` version (if you missed that in the steps above)
71
+
- merge `assisted-ui-lib` version update (if you missed that in the steps above)
73
72
- open a merge request to `uhc-portal`
74
73
- confirm new `facet` project release - **append** description if needed
75
74
- Pass through all Jira and Bugzilla tickets and **fill `Fixed in version`**
76
-
- use [facet-lib's release notes](https://github.com/mareklibra/facet-lib/releases) to guide you
75
+
- use [assisted-ui-lib's release notes](https://github.com/openshift-assisted/assisted-ui-lib/releases) to guide you
77
76
- *Note:* We are working on automating this step
78
77
79
78
- **Announce** new release on `#forum-assisted-installer-qe` slack channel to trigger QA
xdg-open "https://github.com/openshift-metal3/facet/releases/new?tag=v${FACET_LIB_VERSION}&title=v${FACET_LIB_VERSION}&body=REMOVE THIS REMINDER: Do not forget to merge pull-request with facet-lib update BEFORE creating new release here.%0A%0A${TAG}: https://github.com/mareklibra/facet-lib/releases/tag/v${FACET_LIB_VERSION}"&
79
+
xdg-open "https://github.com/openshift-metal3/facet/releases/new?tag=v${ASSISTED_UI_LIB_VERSION}&title=v${ASSISTED_UI_LIB_VERSION}&body=REMOVE THIS REMINDER: Do not forget to merge pull-request with openshift-assisted-ui-lib update BEFORE creating new release here.%0A%0A${TAG}: https://github.com/openshift-assisted/assisted-ui-lib/releases/tag/v${ASSISTED_UI_LIB_VERSION}"&
80
80
xdg-open https://github.com/${GITHUB_USER}/facet/pull/new/${UPDATE_BRANCH}&# <--- Pay attention to this before creating a new release in facet!
81
81
82
82
echo -e "All set. Continue by create and ${GREEN_COLOR}merge${NC} Pull Request in the facet project"
0 commit comments