feat: add api release preparation scripts, github release creation scripts #4704
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
pichlermarc
commented
May 14, 2024
| @@ -97,13 +97,13 @@ All notable changes to this project will be documented in this file. | |||
|
|
|||
| * export tracer options ([#154](https://www.github.com/open-telemetry/opentelemetry-js-api/issues/154)) ([b125324](https://www.github.com/open-telemetry/opentelemetry-js-api/commit/b125324438fb2f24eb80c7c6673afc8cfc99575e)) | |||
|
|
|||
| ### [1.0.4](https://www.github.com/open-telemetry/opentelemetry-js-api/compare/v1.0.3...v1.0.4) (2021-12-18) | |||
| ## [1.0.4](https://www.github.com/open-telemetry/opentelemetry-js-api/compare/v1.0.3...v1.0.4) (2021-12-18) | |||
There was a problem hiding this comment.
Reviewer note: empty ### sections are removed by the changelog prep script, so I'm aligning them here to ensure they don't get removed.
pichlermarc
changed the title
trentm
approved these changes
May 16, 2024
scripts/get-version.js
Outdated
| const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8')); | ||
|
|
||
| if(packageJson.private === true || packageJson.private === 'true'){ | ||
| console.log('Skipping version from private package at', packageJsonPath); |
There was a problem hiding this comment.
nit: Do you want these warning/error cases to use console.warn so they go to stderr perhaps? Otherwise, if you hit the accidental error case, then npm run _github:draft_release:* could result in weird args being sent to gh release create ...
| const fs = require('fs'); | ||
|
|
||
| const changelog = fs.readFileSync(process.argv[2]).toString(); | ||
| const firstReleaseNoteEntryExp = /^## \d+\.\d+\.\d\n.*?(?=^## )/ms; |
There was a problem hiding this comment.
Can we add a comment describing the regex for future explorers?
|
/easycla |
… is a version by checking against a regex
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.
Which problem is this PR solving?
Adds a few more script for release-automation that I usually did by hand. Moving us closer to having a fully-automated solution.
This adds:
<version ranges. Before this I used to manually update all dependencies, which was error-prone and tedious.A.B.Cis allowed^A.B.Cis allowed (default for instrumentation packages)>=A.B.C <X.Y.Zis allowed (default for SDK packages)CHANGELOG.md(up to 3 times per release), manually typing the release title and manually creating a tag.api/CHANGELOG.mdPR creation, publishing packages and publishing Github Releases remains manual.
Additional changes:
peer-api-checkto some packages where it was missingapi/CHANGELOG.mdto avoid having them removed by the automatic updating ofapi/CHANGELOG.mdNext steps:
How Has This Been Tested?