Add make-official-release script #1524
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
peaBerberian
added
the
script
peaBerberian
force-pushed
the
misc/new-release-script
branch
15 times, most recently
from
5e0e3cf to
598d4d4
Compare
peaBerberian
added
the
Priority: 2 (Medium)
peaBerberian
force-pushed
the
misc/new-release-script
branch
8 times, most recently
from
640ee5a to
fd4c9d0
Compare
peaBerberian
changed the title
peaBerberian
added a commit
that referenced
this pull request
Sep 4, 2024
I noticed that the `scripts` directory, which begins to have a lot of files as we automate more tasks (like #1524), wasn't linted. That directory contains code in two languages BASH and JS (Node.js), with a move to prefer JS files (as it's a JS/TS project). So I chose to add an `.eslintrc.js` file (which is a deprecated format but I couldn't make the new one work) and lint script on that directory. I subsequently fixed some linting errors. For now, that script isn't run by our GitHub actions, I will see whether we can do an intelligent kind of runner which detects if scripts have been updated.
peaBerberian
added a commit
that referenced
this pull request
Sep 4, 2024
I noticed that the `scripts` directory, which begins to have a lot of files as we automate more tasks (like #1524), wasn't linted. That directory contains code in two languages BASH and JS (Node.js), with a move to prefer JS files (as it's a JS/TS project). So I chose to add an `.eslintrc.js` file (which is a deprecated format but I couldn't make the new one work) and lint script on that directory. I subsequently fixed some linting errors. For now, that script isn't run by our GitHub actions, I will see whether we can do an intelligent kind of runner which detects if scripts have been updated.
peaBerberian
added a commit
that referenced
this pull request
Sep 4, 2024
I noticed that the `scripts` directory, which begins to have a lot of files as we automate more tasks (like #1524), wasn't linted. That directory contains code in two languages BASH and JS (Node.js), with a move to prefer JS files (as it's a JS/TS project). So I chose to add an `.eslintrc.js` file (which is a deprecated format but I couldn't make the new one work) and lint script on that directory. I subsequently fixed some linting errors. For now, that script isn't run by our GitHub actions, I will see whether we can do an intelligent kind of runner which detects if scripts have been updated.
peaBerberian
added a commit
that referenced
this pull request
Sep 4, 2024
I noticed that the `scripts` directory, which begins to have a lot of files as we automate more tasks (like #1524), wasn't linted. That directory contains code in two languages BASH and JS (Node.js), with a move to prefer JS files (as it's a JS/TS project). So I chose to add an `.eslintrc.js` file (which is a deprecated format but I couldn't make the new one work) and lint script on that directory. I subsequently fixed some linting errors. For now, that script isn't run by our GitHub actions, I will see whether we can do an intelligent kind of runner which detects if scripts have been updated.
peaBerberian
force-pushed
the
misc/new-release-script
branch
from
fd4c9d0 to
b028e7f
Compare
peaBerberian
force-pushed
the
misc/new-release-script
branch
4 times, most recently
from
410a673 to
b394f40
Compare
peaBerberian
force-pushed
the
misc/new-release-script
branch
from
b394f40 to
b3c657e
Compare
Florent-Bouisset
force-pushed
the
misc/new-release-script
branch
from
c904fca to
b3c657e
Compare
Florent-Bouisset
approved these changes
Oct 1, 2024
Comment on lines
+69
to
+76
| check_dependency git | ||
| check_dependency echo | ||
| check_dependency npm | ||
| check_dependency cut | ||
| check_dependency grep | ||
| check_dependency sed | ||
| check_dependency sleep | ||
|
|
There was a problem hiding this comment.
I like that it checks every requirements before attempting to create branch/publish because it could be annoying if the script fail midway
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR tries to facilitate and improve the action of making releases (both development releases and official releases) in the RxPlayer:
For official releases: a new
scripts/make-official-release.shscript was added.Before, the steps to make one were mainly manual and detailed in
doc/contributing/releases.md.Doing those steps manually was error-prone and stressful (e.g. of making by mistake a tag+release on GitHub's interface before pushing the related dev, or forgetting to update the CHANGELOG.md etc.)
The script performs the same steps, with most of it automatized. For those that cannot be automatized easily (e.g. looking at our CI's result on GitHub, checking that the API documentation and demo works as expected etc.), the script will pause, tell you what you need to do manually and propose an input to continue once it's done.
I also added some text on each of those "pause" to indicate what to do if you wanted to abort at that point. You will then be able to re-launch the script later when you're ready.
Add verification in all those scripts whether the version's name is already taken either as a git's branch or as an npm release (may also do as a git tag in the future) and abort in the beginning if it's the case.
Automatically pre-construct the
CHANGELOG,mdfile each time a new release (dev like official) is done.This would be done by checking merge requests since the last
CHANGELOG.mdchange when the user calls a script to make a new release. User intervention on this changelog will be asked after this (e.g. to "categorize" those change proposal into features, bug fixes and so on).