apisix icon indicating copy to clipboard operation
apisix copied to clipboard

bug: ./utils/install-dependencies.sh use a wrong link about linux-install-luarocks.sh

Open zll600 opened this issue 1 year ago • 20 comments

Current Behavior

the script ./utils/install-dependencies.sh on tag 3.7.0 will use linux-install-luarocks.sh which is on master. https://github.com/apache/apisix/blob/ec77fb8ca2e797aa90d6547a1e323d4f40e27527/utils/install-dependencies.sh#L115

Expected Behavior

the script ./utils/install-dependencies.sh on tag 3.7.0 should use linux-install-luarocks.sh which is on tag 3.7.0.

Error Logs

No response

Steps to Reproduce

  1. ./utils/install-dependencies.sh (on tag 3.7.0)

Environment

  • APISIX version (run apisix version):
  • Operating system (run uname -a):
  • OpenResty / Nginx version (run openresty -V or nginx -V):
  • etcd version, if relevant (run curl http://127.0.0.1:9090/v1/server_info):
  • APISIX Dashboard version, if relevant:
  • Plugin runner version, for issues related to plugin runners:
  • LuaRocks version, for installation issues (run luarocks --version):

zll600 avatar Jan 08 '24 01:01 zll600

Hi @zll600 , thank you for reporting, would you be interested to create a PR ?

sheharyaar avatar Jan 08 '24 05:01 sheharyaar

the master branch already update this https://github.com/apache/apisix/blob/1a34a29af57213b529e94a2c9962650b776ff954/utils/install-dependencies.sh#L139

Vacant2333 avatar Jan 08 '24 07:01 Vacant2333

maybe also need to update here: https://github.com/apache/apisix/blob/1a34a29af57213b529e94a2c9962650b776ff954/autodocs/generate.sh#L27

zll600 avatar Jan 08 '24 07:01 zll600

the master branch already update this

https://github.com/apache/apisix/blob/1a34a29af57213b529e94a2c9962650b776ff954/utils/install-dependencies.sh#L139

what should we do with the existing release branch? such as release/3.7 https://github.com/apache/apisix/blob/release/3.7/utils/install-dependencies.sh#L114

zll600 avatar Jan 08 '24 07:01 zll600

@AlinsRan could u help him confirm this?

Vacant2333 avatar Jan 10 '24 16:01 Vacant2333

what should we do with the existing release branch? such as release/3.7 https://github.com/apache/apisix/blob/release/3.7/utils/install-dependencies.sh#L114

We can update in the history branch, such as release/3.7. Would you be interested to create a PR.

AlinsRan avatar Jan 11 '24 01:01 AlinsRan

i can help this, pls assign to me @AlinsRan

Vacant2333 avatar Jan 18 '24 13:01 Vacant2333

If we want to ensure that the historical version can be installed normally, we need to keep the old script and use the new script in the new version. This way, there is no need to update all historical branches.

AlinsRan avatar Jan 19 '24 05:01 AlinsRan

@AlinsRan Sorry. The historical version refer the file which on master branch which should be the latest version. So I do not understand here.

we need to keep the old script and use the new script in the new version.

Can you explain more? Thank you.

zll600 avatar Jan 19 '24 06:01 zll600

@zll600 What I mean is that historical versions still use scripts from the master branch for installation. For example, 3.3 3.4, this can cause the source code installation to fail. There are two solutions to solve this problem:

  • Update documents and scripts in all historical versions.
  • The script of the master branch is compatible with historical versions

AlinsRan avatar Jan 19 '24 07:01 AlinsRan

@zll600 What I mean is that historical versions still use scripts from the master branch for installation. For example, 3.3 3.4, this can cause the source code installation to fail. There are two solutions to solve this problem:

  • Update documents and scripts in all historical versions.
  • The script of the master branch is compatible with historical versions

Ok, i got it, we have update the priority to High now

Vacant2333 avatar Jan 19 '24 12:01 Vacant2333

hello, everyone, i may have no time to update this issue, did anyone want to fix this docs?

Vacant2333 avatar Jan 20 '24 05:01 Vacant2333

The following two lines of code in the historical branch need to be updated. The branch information is release_2.13 ~ 3.8

https://github.com/apache/apisix/blob/1a34a29af57213b529e94a2c9962650b776ff954/utils/install-dependencies.sh#L144

https://github.com/apache/apisix/blob/1a34a29af57213b529e94a2c9962650b776ff954/autodocs/generate.sh#L27

@Vacant2333 @AlinsRan @zll600 Can you help me confirm that the furthest branch is 2.13? I checked and there is no corresponding code before 2.13.

smileby avatar Jan 25 '24 16:01 smileby

@smileby I found the script was add in v2.11.0 by this pr: https://github.com/apache/apisix/pull/5209

zll600 avatar Jan 26 '24 00:01 zll600

Then I should make modifications to the 2.11.0~3.8.0 version branches. What does everyone think of this?

smileby avatar Jan 26 '24 01:01 smileby

@zll600 What I mean is that historical versions still use scripts from the master branch for installation. For example, 3.3 3.4, this can cause the source code installation to fail. There are two solutions to solve this problem:

  • Update documents and scripts in all historical versions.
  • The script of the master branch is compatible with historical versions

we can update the script of master to be compatible with histroical versions. I think this may be easier.

zll600 avatar Jan 26 '24 01:01 zll600

@zll600 What I mean is that historical versions still use scripts from the master branch for installation. For example, 3.3 3.4, this can cause the source code installation to fail. There are two solutions to solve this problem:

  • Update documents and scripts in all historical versions.
  • The script of the master branch is compatible with historical versions

we can update the script of master to be compatible with histroical versions. I think this may be easier.

I don't think it's good practice to constantly be compatible with older versions, let's see if anyone else has any better ideas

smileby avatar Jan 26 '24 01:01 smileby

@zll600 What I mean is that historical versions still use scripts from the master branch for installation. For example, 3.3 3.4, this can cause the source code installation to fail. There are two solutions to solve this problem:

  • Update documents and scripts in all historical versions.
  • The script of the master branch is compatible with historical versions

we can update the script of master to be compatible with histroical versions. I think this may be easier.

I don't think it's good practice to constantly be compatible with older versions, let's see if anyone else has any better ideas

@AlinsRan @spacewander @pottekkat @kayx23 any better ideas

smileby avatar Jan 26 '24 08:01 smileby

we can update the script of master to be compatible with histroical versions. I think this may be easier.

Vote for this.

spacewander avatar Jan 26 '24 13:01 spacewander

My question is, where do they get their version numbers from and how can they be compatible with older versions?

smileby avatar Jan 29 '24 15:01 smileby