[CI/CD] Update project version

[wxharry]

Type of Issue

• [x] Bug
• [ ] Feature Request
• [ ] Performance issue
• [ ] Help Wanted
• [ ] Documention incomplete
• [ ] Test Improvement
• [ ] Raise a Question

Introduction to the issue

In my previous commit, we updated the version in package.json manually. This could be a problem when contributors are working together. Since hypercrx are going to embrace more contributors, it needs to be fixed as soon as possible.

Possible Fix

1. Command npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git] can help updating a version.

[menbotics[bot]]

This issue has not been replied for 24 hours, please pay attention to this issue: @heming6666 @LiuChangFreeman @xiaoya-Esther @tyn1998 @zhuxiangning

[tyn1998]

Totally agree! We need another strategy to handle version updating.

[wxharry]

I notice that for each update, hypercrx pre-releases but not releases. Why?

[tyn1998]

Maybe pre means preview? Just refer to releases of Qv2ray.

[tyn1998]

We should have "release" for those will be pushed to chrome/edge store.

[wxharry]

Here is what I understand on version updating, please feel free to correct me!

1. The contributors are not responsible for modifying the version number.
2. Version number is a tag given by someone responsible for the project.
3. Any other changes relevant to the Version number is done by CI/CD.
4. Release and publish is done by CI/CD.
5. Since we are using numbers not latest to label the releases, there will be history of releases.

[tyn1998]

Hey Harray! Sorry to tell you that I, in practice, do not have a clear picture about the version management things. But I can give you some facts and what flow hypercrx might need.

Facts:

• 3 files are related to version numbers
  • package.json (the number in this file will also be written into manifest.json by one of the webpack plugins)
  • publish/update_information.json (the file will be read in CI/CD and then pushed to oss for version checking on user end)
  • src/mock/background.data.ts (this is mock version of update_infomation.json, only used in development)
• currently I modify the version number after fixing a bug or adding a feature, MANUALLY, which is a bad way

Needs:

• "release" should means the packages will be published on Chrome/Edge stores
• PRs that fix a typo should not trigger a workflow that produce a "release" packages
  • but they still produce packages
• it is the maintainer(s) that manually trigger the "release" workflow

Notes: Since the version numbers are in .json .ts files, so we may figure a way out to allow CI/CD workflow to change these numbers easily. e.g. a higher level constant value which will be imported in files?

[tyn1998]

We'd better learn from other well organized projects :)

[wxharry]

Thank you for your reply! It is really important to figure out what hypercrx needs before getting started and now I am having a basic picture. As for those numbers, maybe we can use js scripts to update and it can be triggered in CI/CD. I am also a beginner on this and is looking for other projects for a practical way to do this. Any examples and ideas are welcome!

[tyn1998]

Keep discussing~

[wxharry]

We can add scripts to the project to handle the release and deployment work. Inspired by how prettier handle releases. And scripts on https://github.com/hypertrons/hypertrons-crx/issues/290 can also be added to it.

[tyn1998]

Thanks for the info, I will look into it!