docs(main): support arm64 release docs #2510

cuisongliu · 2023-11-06T11:34:00Z

No description provided.

YJDoc2 · 2023-11-07T08:48:06Z

Hey, I think it would be a good idea to add platforms for which we are supporting youki and their level of support in readme / docs. For example x64 has tier-1 support, where are after your PRs, we will have tier-3 support for arm , rest platforms are unsupported etc.

jprendes

Thanks for working on this!
The README for libcontainer talks about how to build on musl.
Since your PR also adds support for musl builds, it would be nice to update that file.
Would you be happy to update it? Otherwise, please create an issue so that we remember to update it in a different PR :-)

jprendes · 2023-11-07T09:08:26Z

docs/src/user/basic_setup.md

@@ -47,11 +47,11 @@ Install from the GitHub release.
 Note that this way also requires the aforementioned installation.

 ```console
-$ wget https://github.com/containers/youki/releases/download/v0.3.0/youki_0_3_0_linux.tar.gz
-$ tar -zxvf youki_0_3_0_linux.tar.gz youki_0_3_0_linux/youki-0.3.0/youki
+$ wget https://github.com/containers/youki/releases/download/v0.3.0/youki_0_3_0_linux-$(arch).tar.gz


shouldn't this be $(uname -m)?

cuisongliu · 2023-11-10T12:28:18Z

@utam0k In fact, I have an idea. The document does not need to be changed. When we officially release it, can we use the robot to automatically submit the commit without having to modify the document every time?

using GitHub Action: peter-evans/create-pull-request@v5

utam0k · 2023-11-13T11:55:39Z

docs/src/user/basic_setup.md

 ```console
-$ wget https://github.com/containers/youki/releases/download/v0.3.0/youki_0_3_0_linux.tar.gz
-$ tar -zxvf youki_0_3_0_linux.tar.gz youki_0_3_0_linux/youki-0.3.0/youki
+$ wget https://github.com/containers/youki/releases/download/v0.3.0/youki_0_3_0_linux-$(uname -m).tar.gz
+$ tar -zxvf youki_0_3_0_linux-$(uname -m).tar.gz
 # Maybe you need root privileges.
-$ mv youki_0_3_0_linux/youki-0.3.0/youki /usr/local/bin/youki
-$ rm -rf youki_0_3_0_linux.tar.gz youki_0_3_0_linux
+$ mv youki_0_3_0_linux-$(uname -m)/youki-0.3.0/youki /usr/local/bin/youki
+$ rm -rf youki_0_3_0_linux-$(uname -m).tar.gz youki_0_3_0_linux-$(uname -m)
 ```


Could you keep the method before v0.3.0 using <details>?
Like that:

version < v0.3.0

$ wget https://github.com/containers/youki/releases/download/v0.3.0/youki_0_3_0_linux.tar.gz $ tar -zxvf youki_0_3_0_linux.tar.gz youki_0_3_0_linux/youki-0.3.0/youki # Maybe you need root privileges. $ mv youki_0_3_0_linux/youki-0.3.0/youki /usr/local/bin/youki $ rm -rf youki_0_3_0_linux.tar.gz youki_0_3_0_linux

utam0k · 2023-11-13T11:56:31Z

@utam0k In fact, I have an idea. The document does not need to be changed. When we officially release it, can we use the robot to automatically submit the commit without having to modify the document every time?

using GitHub Action: peter-evans/create-pull-request@v5

I appreciate your suggestion 🙏 But how about this in the case of this PR? I'd like to avoid the increase of load for the maintainers.
https://github.com/containers/youki/pull/2510/files#r1391017650

codecov-commenter · 2023-11-13T12:50:58Z

Codecov Report

Merging #2510 (a3a2b2b) into main (08c0a23) will decrease coverage by 0.01%.
Report is 6 commits behind head on main.
The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2510      +/-   ##
==========================================
- Coverage   65.91%   65.91%   -0.01%     
==========================================
  Files         133      133              
  Lines       16872    16872              
==========================================
- Hits        11122    11121       -1     
- Misses       5750     5751       +1

cuisongliu · 2023-11-13T13:47:29Z

@utam0k In fact, I have an idea. The document does not need to be changed. When we officially release it, can we use the robot to automatically submit the commit without having to modify the document every time?
using GitHub Action: peter-evans/create-pull-request@v5

I appreciate your suggestion 🙏 But how about this in the case of this PR? I'd like to avoid the increase of load for the maintainers. https://github.com/containers/youki/pull/2510/files#r1391017650

cuisongliu#42 This PR is my release test.

GitHub Action automatically generates generator documentation when a new version is released.

cuisongliu · 2023-11-13T13:48:36Z

But this PR depends on #2498

utam0k · 2023-11-14T12:14:20Z

cuisongliu#42 This PR is my release test.

GitHub Action automatically generates generator documentation when a new version is released.

It looks great! May I ask you to provide the workflow?

cuisongliu · 2023-11-14T15:05:04Z

cuisongliu#42 This PR is my release test.

GitHub Action automatically generates generator documentation when a new version is released.

It looks great! May I ask you to provide the workflow?

This PR already includes the submission of the workflow. https://github.com/containers/youki/pull/2510/files#diff-87db21a973eed4fef5f32b267aa60fcee5cbdf03c67fafdc2a9b553bb0b15f34R98

.github/workflows/release.yml

scripts/release_tag.sh

.github/workflows/release.yml

Signed-off-by: cuisongliu <[email protected]>

cuisongliu · 2023-11-18T09:33:07Z

this pr is ready @utam0k

utam0k · 2023-11-18T10:35:02Z

justfile

-    git grep -l "^version = .* # MARK: Version" | xargs sed -i 's/version = "[0-9]\.[0-9]\.[0-9]" # MARK: Version/version = "{{version}}" # MARK: Version/g'
-    sed -i s/_[0-9]_[0-9]_[0-9]_/_{{ replace(version, '.', '_') }}_/g  docs/src/user/basic_setup.md
-    sed -i 's/[0-9]\.[0-9]\.[0-9]/{{version}}/g'  docs/src/user/basic_setup.md


Why can we delete them? 🤔

I took the script to implement it separately. There is something wrong with this writing, and there is a problem with the replacement of the specific version number involved in the version upgrade. Of course, the version does not support aarch64, and the next version will support it.

Will scripts/release_tag.sh replace the version tags in Cargo.toml?

Will scripts/release_tag.sh replace the version tags in Cargo.toml?

Then maybe I need to adjust. This script automatically creates a PR after we publish it, and automatically modifies it after the PR is merged. But I know Cargo.toml needs to be modified before merging. Do I understand correctly?

Ideal for the release flow, I think:

Manually trigger a CI to prepare for the release. Update Cargo.tomls, docs, and so on

We merged it

Automatically push a new tag

Release CI starts run by pushing a new tag.

cuisongliu · 2023-11-20T05:58:29Z

https://github.com/cuisongliu/youki/actions/runs/6925964479
https://github.com/cuisongliu/youki/releases

auto update version is ready @utam0k

utam0k · 2023-11-21T11:20:21Z

.github/workflows/release.yml

+      - name: Version update
+        run: |
+          sudo env PATH=$PATH just version-up ${{ env.VERSION }}


Before running release CI, we need to update a version in Cargo.toml

Before running release CI, we need to update a version in Cargo.toml

Wouldn't it be better to modify it when publishing? Do we need to submit a separate PR to modify the version number?

https://github.com/containers/youki/pull/2510/files#diff-deb9bb56fb122db0b605aa5b63f95a4665c905b18dd670e1fa6c877576a94ff1R194

This script already supports automatic modification of Cargo.toml

Who will version Cargo.toml after release? For example, create a tag v2.0.0 and push. But then the tag's branch, Cargo.toml, is not 2.0.0, is it?

Yes, the branch is not, but the corresponding file has been changed, and pr will be automatically submitted to modify these versions later.

I feel that the branch needs to be in a released state for later reference.

Can't we just create a PR for the release and create a tag once it is merged?

Of course I'd like this feature! However, I feel a little problem with the flow. The concept itself is good.

Can't we just create a PR for the release and create a tag once it is merged?

Indeed, it‘s better to adjust the process. Just do a manual workflow.

Signed-off-by: cuisongliu <[email protected]>

cuisongliu · 2023-11-23T00:59:37Z

Manually trigger CI and automatically submit PR

release and create a tag

utam0k

Works fine! Thanks 😍

jprendes reviewed Nov 7, 2023

View reviewed changes

cuisongliu force-pushed the release-docs branch from daed095 to 09579a5 Compare November 8, 2023 04:33

utam0k added the kind/documentation label Nov 10, 2023

utam0k reviewed Nov 13, 2023

View reviewed changes

cuisongliu force-pushed the release-docs branch 3 times, most recently from 32ee8d5 to 357c512 Compare November 13, 2023 12:48

cuisongliu force-pushed the release-docs branch 4 times, most recently from 1a20392 to 5fd0be1 Compare November 13, 2023 13:32

cuisongliu marked this pull request as ready for review November 13, 2023 13:48

cuisongliu force-pushed the release-docs branch from 5fd0be1 to d52dcba Compare November 14, 2023 02:31

utam0k reviewed Nov 17, 2023

View reviewed changes

.github/workflows/release.yml Outdated Show resolved Hide resolved

utam0k reviewed Nov 17, 2023

View reviewed changes

scripts/release_tag.sh Outdated Show resolved Hide resolved

utam0k reviewed Nov 17, 2023

View reviewed changes

.github/workflows/release.yml Outdated Show resolved Hide resolved

cuisongliu force-pushed the release-docs branch 2 times, most recently from bf5d4dd to 8d2c2e8 Compare November 17, 2023 09:01

docs(main): support arm64 release docs

d65d383

Signed-off-by: cuisongliu <[email protected]>

cuisongliu force-pushed the release-docs branch from 8d2c2e8 to d65d383 Compare November 18, 2023 02:34

docs(main): support arm64 release docs

0b519e5

Signed-off-by: cuisongliu <[email protected]>

utam0k reviewed Nov 18, 2023

View reviewed changes

cuisongliu force-pushed the release-docs branch 6 times, most recently from 12f838c to 695358d Compare November 20, 2023 05:27

utam0k reviewed Nov 21, 2023

View reviewed changes

docs(main): support arm64 release docs

a3a2b2b

Signed-off-by: cuisongliu <[email protected]>

cuisongliu force-pushed the release-docs branch from 695358d to a3a2b2b Compare November 23, 2023 00:36

cuisongliu mentioned this pull request Nov 23, 2023

Simplify release workflow #2541

Merged

utam0k approved these changes Nov 26, 2023

View reviewed changes

utam0k merged commit ac20fc3 into youki-dev:main Nov 26, 2023
15 checks passed

cuisongliu deleted the release-docs branch November 26, 2023 05:26

This was referenced Dec 17, 2023

Release for v0.3.1 #2570

Merged

Release for v0.3.1 #2578

Merged

Release for v0.3.1 #2579

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(main): support arm64 release docs #2510

docs(main): support arm64 release docs #2510

cuisongliu commented Nov 6, 2023

YJDoc2 commented Nov 7, 2023

jprendes left a comment

jprendes Nov 7, 2023

cuisongliu commented Nov 10, 2023 •

edited

Loading

utam0k Nov 13, 2023

utam0k commented Nov 13, 2023 •

edited

Loading

codecov-commenter commented Nov 13, 2023 •

edited

Loading

cuisongliu commented Nov 13, 2023

cuisongliu commented Nov 13, 2023

utam0k commented Nov 14, 2023 •

edited

Loading

cuisongliu commented Nov 14, 2023

cuisongliu commented Nov 18, 2023

utam0k Nov 18, 2023 •

edited

Loading

cuisongliu Nov 18, 2023

utam0k Nov 19, 2023

cuisongliu Nov 19, 2023

utam0k Nov 21, 2023 •

edited

Loading

cuisongliu commented Nov 20, 2023

utam0k Nov 21, 2023

cuisongliu Nov 21, 2023

cuisongliu Nov 21, 2023

utam0k Nov 22, 2023

cuisongliu Nov 22, 2023

utam0k Nov 22, 2023

utam0k Nov 22, 2023

utam0k Nov 22, 2023

cuisongliu Nov 23, 2023

cuisongliu commented Nov 23, 2023 •

edited

Loading

utam0k left a comment

docs(main): support arm64 release docs #2510

docs(main): support arm64 release docs #2510

Conversation

cuisongliu commented Nov 6, 2023

YJDoc2 commented Nov 7, 2023

jprendes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cuisongliu commented Nov 10, 2023 • edited Loading

Choose a reason for hiding this comment

utam0k commented Nov 13, 2023 • edited Loading

codecov-commenter commented Nov 13, 2023 • edited Loading

Codecov Report

cuisongliu commented Nov 13, 2023

cuisongliu commented Nov 13, 2023

utam0k commented Nov 14, 2023 • edited Loading

cuisongliu commented Nov 14, 2023

cuisongliu commented Nov 18, 2023

utam0k Nov 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

utam0k Nov 21, 2023 • edited Loading

Choose a reason for hiding this comment

cuisongliu commented Nov 20, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cuisongliu commented Nov 23, 2023 • edited Loading

utam0k left a comment

Choose a reason for hiding this comment

cuisongliu commented Nov 10, 2023 •

edited

Loading

utam0k commented Nov 13, 2023 •

edited

Loading

codecov-commenter commented Nov 13, 2023 •

edited

Loading

utam0k commented Nov 14, 2023 •

edited

Loading

utam0k Nov 18, 2023 •

edited

Loading

utam0k Nov 21, 2023 •

edited

Loading

cuisongliu commented Nov 23, 2023 •

edited

Loading